robot.libdocpkg.model.KeywordDoc Class Reference

Documentation for a single keyword or an initializer. More...

Inheritance diagram for robot.libdocpkg.model.KeywordDoc:

Public Member Functions
def	__init__ (self, name='', args=None, doc='', shortdoc='', tags=(), private=False, deprecated=False, source=None, lineno=-1, parent=None)
def	to_dictionary (self)

Public Attributes
	args
	deprecated
	doc
	lineno
	name
	parent
	private
	source
	tags
	type_docs

Properties
	_sort_key = property
	shortdoc = property

Private Member Functions
def	_arg_to_dict (self, arg)
def	_doc_to_shortdoc (self)
def	_sort_key (self)
def	shortdoc (self)
def	shortdoc (self, shortdoc)

Private Attributes
	_shortdoc

Detailed Description

Documentation for a single keyword or an initializer.

Definition at line 156 of file model.py.

Constructor & Destructor Documentation

__init__()

def robot.libdocpkg.model.KeywordDoc.__init__	(		self,
			name = '',
			args = None,
			doc = '',
			shortdoc = '',
			tags = (),
			private = False,
			deprecated = False,
			source = None,
			lineno = -1,
			parent = None
	)

Definition at line 158 of file model.py.

Member Function Documentation

_arg_to_dict()

def robot.libdocpkg.model.KeywordDoc._arg_to_dict (   self,   arg  )

private

Definition at line 213 of file model.py.

_doc_to_shortdoc()

def robot.libdocpkg.model.KeywordDoc._doc_to_shortdoc (   self )

private

Definition at line 179 of file model.py.

_sort_key()

def robot.libdocpkg.model.KeywordDoc._sort_key (   self )

private

Definition at line 194 of file model.py.

shortdoc() [1/2]

def robot.libdocpkg.model.KeywordDoc.shortdoc (   self )

private

Definition at line 176 of file model.py.

shortdoc() [2/2]

def robot.libdocpkg.model.KeywordDoc.shortdoc (   self,   shortdoc  )

private

Definition at line 188 of file model.py.

to_dictionary()

def robot.libdocpkg.model.KeywordDoc.to_dictionary

(

self

)

Definition at line 197 of file model.py.

Member Data Documentation

_shortdoc

robot.libdocpkg.model.KeywordDoc._shortdoc

private

Definition at line 163 of file model.py.

args

robot.libdocpkg.model.KeywordDoc.args

Definition at line 161 of file model.py.

deprecated

robot.libdocpkg.model.KeywordDoc.deprecated

Definition at line 166 of file model.py.

doc

robot.libdocpkg.model.KeywordDoc.doc

Definition at line 162 of file model.py.

lineno

robot.libdocpkg.model.KeywordDoc.lineno

Definition at line 168 of file model.py.

name

robot.libdocpkg.model.KeywordDoc.name

Definition at line 160 of file model.py.

parent

robot.libdocpkg.model.KeywordDoc.parent

Definition at line 169 of file model.py.

private

robot.libdocpkg.model.KeywordDoc.private

Definition at line 165 of file model.py.

source

robot.libdocpkg.model.KeywordDoc.source

Definition at line 167 of file model.py.

tags

robot.libdocpkg.model.KeywordDoc.tags

Definition at line 164 of file model.py.

type_docs

robot.libdocpkg.model.KeywordDoc.type_docs

Definition at line 171 of file model.py.

Property Documentation

_sort_key

robot.libdocpkg.model.KeywordDoc._sort_key = property

staticprivate

Definition at line 192 of file model.py.

shortdoc

robot.libdocpkg.model.KeywordDoc.shortdoc = property

static

Definition at line 174 of file model.py.

---

The documentation for this class was generated from the following file:

• src/robot/libdocpkg/model.py