Public Member Functions | Public Attributes | List of all members
docs.Docs Class Reference

Public Member Functions

def __init__ (self, class_docs, free_docs)
 
def get_class_docs (self, class_name)
 
def get_class_docs_keys_list (self)
 
def get_class_docs_values_list (self)
 
def get_free_docs (self, free_func_name)
 
def get_free_docs_keys_list (self)
 
def get_free_docs_values_list (self)
 

Public Attributes

 class_docs
 
 free_docs
 

Detailed Description

Definition at line 32 of file docs.py.

Constructor & Destructor Documentation

◆ __init__()

def docs.Docs.__init__ (   self,
  class_docs,
  free_docs 
)

Definition at line 33 of file docs.py.

Member Function Documentation

◆ get_class_docs()

def docs.Docs.get_class_docs (   self,
  class_name 
)
Get the documentation for the class.

Arguments:
class_name -- the name of the class

Returns:
The ClassDoc with the class's documentation. None if the class does not
exist.

Definition at line 38 of file docs.py.

◆ get_class_docs_keys_list()

def docs.Docs.get_class_docs_keys_list (   self)

Definition at line 62 of file docs.py.

◆ get_class_docs_values_list()

def docs.Docs.get_class_docs_values_list (   self)

Definition at line 68 of file docs.py.

◆ get_free_docs()

def docs.Docs.get_free_docs (   self,
  free_func_name 
)
Get the documentation for a free function.

Arguments:
free_func_name -- the name of the free function

Returns:
The FreeDoc with the free function's documentation. None if the class
does not exist.

Definition at line 50 of file docs.py.

◆ get_free_docs_keys_list()

def docs.Docs.get_free_docs_keys_list (   self)

Definition at line 65 of file docs.py.

◆ get_free_docs_values_list()

def docs.Docs.get_free_docs_values_list (   self)

Definition at line 71 of file docs.py.

Member Data Documentation

◆ class_docs

docs.Docs.class_docs

Definition at line 35 of file docs.py.

◆ free_docs

docs.Docs.free_docs

Definition at line 36 of file docs.py.


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


gtsam
Author(s):
autogenerated on Tue Jul 4 2023 02:41:10