Top Documents Download Gallery Repository
Are you looking for a Software Engineer? Check Here

17doxygen Module

The doxygen module provides measures to parse a document written in Doxygen syntax. To utilize it, import the doxygen module using import function.

+----------+  1.. +-----------+  1.. +------+
| document *------| structure *------| elem |
+----------+      +-----------+      +------+

+---------------+  1 +---------+
| configuration *----| aliases |
+---------------+    +---------+

+----------+     +-------------------+
| renderer |<----| specific_renderer |
+----------+     +-------------------+

17.1doxygen.document Class

17.1.1Constructor

doxygen.document
doxygen.document(stream?:stream, aliases?:doxygen.aliases, extracted?:boolean) {block?}
Reads a Doxygen document from stream and creates an instance of doxygen.document class.

The argument aliases is an instance that is available as a member of doxygen.configuration instance and contains information about command aliases, or custom commands in the other word.

In default, the parser expects the Doxygen document is written within C-style comments and extracts the document body from them before parsing. If the argument extracted is set to true, it exepcts the document already have been extracted from the comments.

If block is specified, it would be evaluated with a block parameter |doc:doxygen.document|, where doc is the created instance. In this case, the block's result would become the function's returned value.

17.1.2Method

doxygen.document#structures
doxygen.document#structures() {block?}
Creates an iterator that returns instances of doxygen.structure contained in the doxygen.document.

In default, this returns an iterator as its result value. Specifying the following attributes would customize the returned value:

See the chapter of Mapping Process in Gura Language Manual for the detail.

If a block is specified, it would be evaluated repeatingly with block parameters |value, idx:number| where value is the iterated value and idx the loop index starting from zero. In this case, the last evaluated value of the block would be the result value. If one of the attributes listed above is specified, an iterator or a list of the evaluated value would be returned.

17.2doxygen.structure Class

17.2.1Property

Property Type R/W Explanation
aftermember boolean R

17.2.2Method

doxygen.structure#elems
doxygen.structure#elems():map {block?}
Creates an iterator that returns doxygen.elem instances of all the elements contained in the structure.

In default, this returns an iterator as its result value. Specifying the following attributes would customize the returned value:

See the chapter of Mapping Process in Gura Language Manual for the detail.

If a block is specified, it would be evaluated repeatingly with block parameters |value, idx:number| where value is the iterated value and idx the loop index starting from zero. In this case, the last evaluated value of the block would be the result value. If one of the attributes listed above is specified, an iterator or a list of the evaluated value would be returned.

doxygen.structure#substructures
doxygen.structure#substructures() {block?}
Creates an iterator that returns doxygen.structure instances of sub structures contained in the structure.

In default, this returns an iterator as its result value. Specifying the following attributes would customize the returned value:

See the chapter of Mapping Process in Gura Language Manual for the detail.

If a block is specified, it would be evaluated repeatingly with block parameters |value, idx:number| where value is the iterated value and idx the loop index starting from zero. In this case, the last evaluated value of the block would be the result value. If one of the attributes listed above is specified, an iterator or a list of the evaluated value would be returned.

17.3doxygen.elem Class

17.3.1Method

doxygen.elem#print
doxygen.elem#print(indent?:number, out?:stream):map:void
Prints out the content of the element to out with an indentation level specified by indent that starts from zero. If out is omitted, the result would be put out to standard output.

doxygen.elem#render
doxygen.elem#render(renderer:doxygen.renderer):void
Renders the element content using doxygen.renderer.

17.4doxygen.configuration Class

17.4.1Property

Property Type R/W Explanation
aliases doxygen.aliases R

17.4.2Constructor

doxygen.configuration
doxygen.configuration(stream?:stream) {block?}
Reads a configuration file, which is usually dubbed "Doxyfile", from stream and creates a doxygen.configuration instance.

If block is specified, it would be evaluated with a block parameter |cfg:doxygen.configuration|, where cfg is the created instance. In this case, the block's result would become the function's returned value.

17.4.3Method

doxygen.configuration#get
doxygen.configuration#get(tagname:string):map:[raise]
Returns a value associated with the tag specified by the argument tagname.

If the specified tag is not found, the method would return nil while it would cause an error in the case the attribute :raise is specified.

doxygen.configuration#print
doxygen.configuration#print(out?:stream):map:void
Prints out the content of the configuration to out. If omitted, the result would be put out to standard output.

17.5doxygen.aliases Class

17.5.1Method

doxygen.aliases#print
doxygen.aliases#print(out?:stream):map:void
Prints out definitions of aliases to the stream out. If the argument is omitted, the result would be put out to the standard output.

17.6doxygen.renderer Class

17.6.1Constructor

doxygen.renderer
doxygen.renderer(out:stream, cfg:doxygen.configuration) {block?}
Creates a doxygen.renderer instance.

If block is specified, it would be evaluated with a block parameter |renderer:doxygen.renderer|, where renderer is the created instance. In this case, the block's result would become the function's returned value.


Copyright (C) 2011-2017 ypsitau