Robot Framework Integrated Development Environment (RIDE)
robotide.lib.robot.libdocpkg.model.LibraryDoc Class Reference

Public Member Functions

def __init__ (self, name='', doc='', version='', type='library', scope='', named_args=True, doc_format='')
 
def doc_format (self, format)
 
def keywords (self, kws)
 
def save (self, output=None, format='HTML')
 

Public Attributes

 doc
 
 doc_format
 
 inits
 
 keywords
 
 name
 
 named_args
 
 scope
 
 type
 
 version
 

Properties

 all_tags = property
 

Private Member Functions

def all_tags (self)
 

Detailed Description

Definition at line 25 of file model.py.

Constructor & Destructor Documentation

◆ __init__()

def robotide.lib.robot.libdocpkg.model.LibraryDoc.__init__ (   self,
  name = '',
  doc = '',
  version = '',
  type = 'library',
  scope = '',
  named_args = True,
  doc_format = '' 
)

Definition at line 27 of file model.py.

Member Function Documentation

◆ all_tags()

def robotide.lib.robot.libdocpkg.model.LibraryDoc.all_tags (   self)
private

Definition at line 50 of file model.py.

◆ doc_format()

def robotide.lib.robot.libdocpkg.model.LibraryDoc.doc_format (   self,
  format 
)

Definition at line 40 of file model.py.

◆ keywords()

def robotide.lib.robot.libdocpkg.model.LibraryDoc.keywords (   self,
  kws 
)

Definition at line 44 of file model.py.

◆ save()

def robotide.lib.robot.libdocpkg.model.LibraryDoc.save (   self,
  output = None,
  format = 'HTML' 
)

Definition at line 53 of file model.py.

Member Data Documentation

◆ doc

robotide.lib.robot.libdocpkg.model.LibraryDoc.doc

Definition at line 30 of file model.py.

◆ doc_format

robotide.lib.robot.libdocpkg.model.LibraryDoc.doc_format

Definition at line 35 of file model.py.

◆ inits

robotide.lib.robot.libdocpkg.model.LibraryDoc.inits

Definition at line 36 of file model.py.

◆ keywords

robotide.lib.robot.libdocpkg.model.LibraryDoc.keywords

Definition at line 37 of file model.py.

◆ name

robotide.lib.robot.libdocpkg.model.LibraryDoc.name

Definition at line 29 of file model.py.

◆ named_args

robotide.lib.robot.libdocpkg.model.LibraryDoc.named_args

Definition at line 34 of file model.py.

◆ scope

robotide.lib.robot.libdocpkg.model.LibraryDoc.scope

Definition at line 33 of file model.py.

◆ type

robotide.lib.robot.libdocpkg.model.LibraryDoc.type

Definition at line 32 of file model.py.

◆ version

robotide.lib.robot.libdocpkg.model.LibraryDoc.version

Definition at line 31 of file model.py.

Property Documentation

◆ all_tags

robotide.lib.robot.libdocpkg.model.LibraryDoc.all_tags = property
static

Definition at line 48 of file model.py.


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