$search

rosdoc::rdcore::RosdocContext Class Reference

List of all members.

Public Member Functions

def __init__
def has_builder
def init
def should_document

Public Attributes

 allow_rosmake
 doc_packages
 docdir
 external_docs
 manifests
 name
 package_filters
 packages
 path_filters
 quiet
 rd_configs
 ros_package_path
 rosroot
 stack_manifests
 stacks
 template_dir
 timings

Private Member Functions

def _crawl_deps

Detailed Description

Definition at line 47 of file rdcore.py.


Member Function Documentation

def rosdoc::rdcore::RosdocContext::__init__ (   self,
  name,
  docdir,
  package_filters = None,
  path_filters = None 
)

Definition at line 49 of file rdcore.py.

def rosdoc::rdcore::RosdocContext::_crawl_deps (   self  )  [private]
Crawl manifest.xml dependencies

Definition at line 161 of file rdcore.py.

def rosdoc::rdcore::RosdocContext::has_builder (   self,
  package,
  builder 
)
@return: True if package is configured to use builder. NOTE:
if there is no config, package is assumed to define a doxygen
builder
@rtype: bool

Definition at line 83 of file rdcore.py.

def rosdoc::rdcore::RosdocContext::init (   self  ) 

Definition at line 123 of file rdcore.py.

def rosdoc::rdcore::RosdocContext::should_document (   self,
  package 
)
@return: True if package should be documented
@rtype: bool

Definition at line 105 of file rdcore.py.


Member Data Documentation

Definition at line 71 of file rdcore.py.

Definition at line 158 of file rdcore.py.

Definition at line 60 of file rdcore.py.

Definition at line 66 of file rdcore.py.

Definition at line 67 of file rdcore.py.

Definition at line 50 of file rdcore.py.

Definition at line 51 of file rdcore.py.

Definition at line 64 of file rdcore.py.

Definition at line 52 of file rdcore.py.

Definition at line 74 of file rdcore.py.

Definition at line 79 of file rdcore.py.

Definition at line 63 of file rdcore.py.

Definition at line 63 of file rdcore.py.

Definition at line 68 of file rdcore.py.

Definition at line 65 of file rdcore.py.

Definition at line 81 of file rdcore.py.

Definition at line 76 of file rdcore.py.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends


rosdoc
Author(s): Ken Conley/kwc@willowgarage.com
autogenerated on Fri Mar 1 15:15:48 2013