Class RDoc::Parser
In: lib/puppet/util/rdoc/parser.rb
Parent: Object

Methods

Constants

SITE = "__site__"

Attributes

ast  [RW] 
input_file_name  [RW] 
top_level  [RW] 

Public Class methods

Public Instance methods

create documentation for a class named name

create documentation for a define

create documentation for a node

Due to a bug in RDoc, we need to roll our own find_module_named The issue is that RDoc tries harder by asking the parent for a class/module of the name. But by doing so, it can mistakenly use a module of same name but from which we are not descendant.

walk down the namespace and lookup/create container as needed

Traverse the AST tree and produce code-objects node that contains the documentation

this is a poor man custom fact parser :-)

create documentation for plugins

this is a poor man puppet plugin parser :-) it doesn‘t extract doc nor desc :-(

main entry point

create documentation for include statements we can find in code and associate it with container

create documentation for realize statements we can find in code and associate it with container

create documentation for resources we can find in code and associate it with container

create documentation for global variables assignements we can find in code and associate it with container

create documentation for the top level container

split_module tries to find if path belongs to the module path if it does, it returns the module name, otherwise if we are sure it is part of the global manifest path, "site" is returned. And finally if this path couldn‘t be mapped anywhere, nil is returned.

[Validate]