valadoc Reference Manual
Packages
valadoc
Valadoc
Valadoc.Api
Valadoc.Charts
Valadoc.Content
Valadoc.Devhelp
Valadoc.Gtkdoc
Valadoc.Highlighter
Valadoc.Html
Valadoc.Importer
Valadoc.ImporterHelper
Valadoc.Taglets
valadoc_gvc_graph_create_edge
valadoc_gvc_graph_create_node
valadoc_gvc_graph_new
valadoc_gvc_init
valadoc
Description:
Content:
Namespaces:
Valadoc
Interfaces:
Doclet
-
Provides a mechanism to inspect the API & documentation of programs and libraries
Documentation
ParserCallback
ResourceLocator
Scanner
Classes:
CTypeResolver
-
Resolves symbols by C-names
CommentScanner
DocumentationParser
ErrorReporter
GirMetaData
-
Metadata reader for GIR files
GtkDocMarkupWriter
GtkdocRenderer
ManyRule
MarkupWriter
-
Writes markups and text to a file.
ModuleLoader
OneOfRule
OptionalRule
Parser
Rule
SequenceRule
Settings
-
Contains information about output settings configuration
StubRule
Token
TokenType
WikiPage
WikiPageTree
WikiScanner
Error domains:
ParserError
Delegates:
public
delegate
Type
DocletRegisterFunction
(
ModuleLoader
module_loader)
A plugin register function for doclets
public
delegate
void
TagletRegisterFunction
(
ModuleLoader
loader)
Methods:
public
bool
copy_directory
(
string
src,
string
dest)
Makes a copy of the directory src to dest.
public
bool
copy_file
(
string
src,
string
dest)
Makes a copy of the file src to dest.
public
bool
remove_directory
(
string
rpath)
A recursive directory delete function
Api
Interfaces:
Callable
-
Used to translate imported C- documentation
Classes:
Array
-
Represents an array declaration.
Attribute
ChildSymbolRegistrar
Class
-
Represents a class declaration.
Constant
-
Represents a type member with a constant value.
Delegate
-
Represents a Delegate.
Enum
-
Represents an enum declaration.
EnumValue
-
Represents an enum member.
ErrorCode
-
Represents an errordomain member in the source code.
ErrorDomain
-
Represents an error domain declaration.
Field
-
Represents a field.
GirSourceComment
-
A documentation comment used by valadoc
Interface
-
Represents a interface declaration in the source code.
Item
-
Represents a node in the api tree.
Method
-
Represents a function or a method.
Namespace
-
Represents a namespace declaration.
Node
-
Represents a node in the api tree.
Package
Parameter
-
Represents a parameter in method, signal and delegate signatures.
Pointer
-
Represents a pointer declaration.
Property
-
Represents a property declaration.
PropertyAccessor
-
Represents a get or set accessor of a property.
Signal
-
Represents an signal.
SignatureBuilder
-
Builds up a signature from the given items.
SourceComment
-
A documentation comment used by valadoc
SourceFile
-
Represents a source file
Struct
-
Represents a struct declaration.
Symbol
-
Represents a node in the symbol tree.
Tree
-
The root of the code tree.
TypeParameter
-
Represents a generic type parameter in the source code.
TypeReference
-
A reference to a data type.
TypeSymbol
-
Represents a runtime data type.
Visitor
-
Abstract visitor for traversing API.
Enums:
NodeType
-
Specifies the context of a node.
Ownership
Charts
Classes:
Chart
Factory
Hierarchy
SimpleFactory
Content
Interfaces:
Block
Inline
StyleAttributes
Taglet
Classes:
BlockContent
Comment
ContentElement
ContentFactory
ContentRenderer
ContentVisitor
Embedded
Headline
InlineContent
InlineTaglet
Link
List
ListItem
Note
Page
Paragraph
Run
SourceCode
SymbolLink
Table
TableCell
TableRow
Text
Warning
WikiLink
Enums:
HorizontalAlign
VerticalAlign
Devhelp
Classes:
MarkupWriter
Gtkdoc
Classes:
MarkdownParser
MarkdownScanner
Parser
Scanner
Token
Enums:
TokenType
Error domains:
ContentToStringError
Highlighter
Interfaces:
Scanner
-
Scanner interface used to highlight source code.
Classes:
CodeScanner
-
A cheap scanner used to highlight C and Vala source code.
CodeToken
Highlighter
XmlScanner
-
A cheap scanner used to highlight XML.
Enums:
CodeTokenType
Html
Classes:
BasicDoclet
CssClassResolver
HtmlRenderer
LinkHelper
MarkupWriter
SimpleChartFactory
Importer
Classes:
DocumentationImporter
GirDocumentationImporter
InternalIdRegistrar
ValadocDocumentationImporter
ValadocDocumentationScanner
ImporterHelper
Methods:
internal
void
extract_short_desc
(
Comment
comment,
ContentFactory
factory)
internal
string
?
resolve_parameter_ctype
(
Tree
tree,
Node
element,
string
parameter_name,
out
string
? param_name,
out
string
? param_array_name,
out
bool
is_return_type_len)
internal
inline
Inline
?
split_inline
(
Inline
item,
ContentFactory
factory)
internal
inline
Paragraph
?
split_paragraph
(
Paragraph
p,
ContentFactory
factory)
internal
inline
Run
?
split_run
(
Run
run,
ContentFactory
factory)
internal
inline
Text
?
split_text
(
Text
text,
ContentFactory
factory)
internal
string
[]?
split_type_name
(
string
id)
Taglets
Classes:
Deprecated
InheritDoc
Link
Param
Return
See
Since
Throws
Methods:
public
void
init
(
ModuleLoader
loader)
Functions:
internal
Edge
valadoc_gvc_graph_create_edge
(
Graph
graph,
Node
from,
Node
to)
internal
Node
valadoc_gvc_graph_create_node
(
Graph
graph,
string
name)
internal
Graph
valadoc_gvc_graph_new
(
string
name)
internal
void
valadoc_gvc_init
()