Valadoc.Api.Tree – valadoc Reference Manual
Packages
valadoc
Valadoc
Api
Tree
InheritDocContainer
context
highlighter
wikitree
Tree
accept
accept_children
add_dependencies_to_source_package
add_external_c_files
add_package
check_comments
check_wiki
create_tree
get_external_c_files
get_file_path
get_package_list
get_source_package
import_comments
parse_comments
parse_wiki
postprocess_inheritdoc
register_inheritdoc
search_relative_to
search_symbol_cstr
search_symbol_path
search_symbol_str
search_symbol_type_cstr
split_name
_context
_cresolver
_highlighter
_source_package
_wikitree
external_c_files
inheritdocs
packages
reporter
settings
source_package
Tree
Object Hierarchy:
Valadoc.Api.Tree
Valadoc.Api.Tree
Valadoc.Api.Tree
Description:
public
class
Tree
The root of the code tree.
Namespace:
Valadoc.Api
Package:
valadoc
Content:
Classes:
InheritDocContainer
Properties:
public
CodeContext
context
{
get
;
set
; }
public
Highlighter
highlighter
{
get
; }
public
WikiPageTree
?
wikitree
{
get
;
private
set
; }
The root of the wiki tree.
Creation methods:
public
Tree
(
ErrorReporter
reporter,
Settings
settings,
CodeContext
context)
Methods:
public
void
accept
(
Visitor
visitor)
Visits this node with the specified Visitor.
public
void
accept_children
(
Visitor
visitor)
Visits all children of this node with the given types with the specified Visitor.
private
void
add_dependencies_to_source_package
()
public
void
add_external_c_files
(
string
name)
public
void
add_package
(
Package
package)
public
void
check_comments
(
DocumentationParser
docparser)
private
void
check_wiki
(
DocumentationParser
docparser)
public
bool
create_tree
()
public
Collection
<
string
>
get_external_c_files
()
Returns a list of C source files.
private
string
?
get_file_path
(
string
basename,
string
[] directories)
public
Collection
<
Package
>
get_package_list
()
Returns a list of all packages in the tree
private
Package
?
get_source_package
()
public
void
import_comments
(
DocumentationImporter
[] importers,
string
[] packages,
string
[] import_directories)
Import documentation from various sources
public
void
parse_comments
(
DocumentationParser
docparser)
private
void
parse_wiki
(
DocumentationParser
docparser)
private
void
postprocess_inheritdoc
(
DocumentationParser
docparser)
internal
void
register_inheritdoc
(
Node
container,
InheritDoc
taglet)
private
Node
?
search_relative_to
(
Node
element,
string
[] path)
public
Node
?
search_symbol_cstr
(
Node
? element,
string
cname)
public
Node
?
search_symbol_path
(
Node
? element,
string
[] path)
public
Node
?
search_symbol_str
(
Node
? element,
string
symname)
public
TypeSymbol
?
search_symbol_type_cstr
(
string
cname)
private
string
[]
split_name
(
string
full_name)
Fields:
private
CodeContext
_context
private
CTypeResolver
_cresolver
private
Highlighter
_highlighter
private
Package
_source_package
private
WikiPageTree
?
_wikitree
private
ArrayList
<
string
>
external_c_files
private
List
<
InheritDocContainer
>
inheritdocs
private
ArrayList
<
Package
>
packages
private
ErrorReporter
reporter
private
Settings
settings
private
Package
source_package