robot API笔记5

实现了 Libdoc 工具。

命令行Libdoc入口点和编程接口 提供的是单独的吗

robot.libdoc

模块。

这个包被认为是稳定的但不是公共API的一部分。

robot.libdocpkg.

LibraryDocumentation

(library_or_resource, name=None, version=None,doc_format=None)

Submodules

robot.libdocpkg.builder module

robot.libdocpkg.builder.

JavaDocBuilder

()

robot.libdocpkg.builder.

DocumentationBuilder

(library_or_resource)

robot.libdocpkg.consoleviewer module

class

robot.libdocpkg.consoleviewer.

ConsoleViewer

(libdoc)

Bases:

object

classmethod

handles

(command)
classmethod

validate_command

(command, args)

view

(command, *args)

list

(*patterns)

show

(*names)

version

()
class

robot.libdocpkg.consoleviewer.

KeywordMatcher

(libdoc)

Bases:

object

search

(patterns)

robot.libdocpkg.htmlwriter module

class

robot.libdocpkg.htmlwriter.

LibdocHtmlWriter

Bases:

object

write

(libdoc, output)
class

robot.libdocpkg.htmlwriter.

LibdocModelWriter

(output, libdoc)

Bases:

robot.htmldata.htmlfilewriter.ModelWriter

write

(line)

write_data

()

handles

(line)class

robot.libdocpkg.htmlwriter.

JsonConverter

(doc_formatter)

Bases:

object

convert

(libdoc)
class

robot.libdocpkg.htmlwriter.

DocFormatter

(keywords, introduction, doc_format='ROBOT')

Bases:

object

html

(doc, intro=False)
class

robot.libdocpkg.htmlwriter.

DocToHtml

(doc_format)

Bases:

object

robot.libdocpkg.javabuilder module

class

robot.libdocpkg.javabuilder.

JavaDocBuilder

Bases:

object

build

(path)

robot.libdocpkg.javabuilder.

ClassDoc

(path)

Process the given Java source file and return ClassDoc instance.

Processing is done using com.sun.tools.javadoc APIs. Returned object implements com.sun.javadoc.ClassDoc interface:http://docs.oracle.com/javase/7/docs/jdk/api/javadoc/doclet/

robot.libdocpkg.model module

class

robot.libdocpkg.model.

LibraryDoc

(name='', doc='', version='', type='library', scope='',named_args=True, doc_format='')

Bases:

object

doc_format

keywords

all_tags

save

(output=None, format='HTML')
class

robot.libdocpkg.model.

KeywordDoc

(name='', args=(), doc='', tags=())

Bases:

robot.utils.sortable.Sortable

shortdoc

robot.libdocpkg.output module

class

robot.libdocpkg.output.

LibdocOutput

(output_path, format)

Bases:

object

robot.libdocpkg.robotbuilder module

class

robot.libdocpkg.robotbuilder.

LibraryDocBuilder

Bases:

object

build

(library)
class

robot.libdocpkg.robotbuilder.

ResourceDocBuilder

Bases:

object

build

(path)
class

robot.libdocpkg.robotbuilder.

KeywordDocBuilder

(resource=False)

Bases:

object

build_keywords

(lib)[

build_keyword

(kw)

robot.libdocpkg.specbuilder module

class

robot.libdocpkg.specbuilder.

SpecDocBuilder

Bases:

object

build

(path)

robot.libdocpkg.writer module

robot.libdocpkg.writer.

LibdocWriter

(format=None)

robot.libdocpkg.xmlwriter module

class

robot.libdocpkg.xmlwriter.

LibdocXmlWriter

Bases:

object

write

(libdoc, outfile)