DoxyUDT Class Reference

Class to handle a Doxyfile. More...

Collaboration diagram for DoxyUDT:

Public Member Functions
	DoxyUDT (BYREF_AS_STRING)
	constructor loading and parsing a Doxyfile More...
	~DoxyUDT ()
	destructor freeing the used memory More...
FUNCTION_AS_STRING	Search (BYREF_AS_STRING, BYREF_AS_INTEGER)
	find a single line tag in the Doxyfile and return its value More...
PROPERTY_AS_STRING	Tag (BYVAL_AS_INTEGER)
	return a tag value More...

Public Attributes
INTEGER	Length
	the length of the buffer More...
UBYTE_PTR	Buffer
	the buffer data More...
ZSTRING_PTR	Doxy = "empty"
	a pointer to interprete the data as STRING More...
STRING	Errr
	an error message (if any) More...
STRING	Tags [XML_OUTPUT+1]
	an array containing the tags context More...

Detailed Description

Class to handle a Doxyfile.

Load a Doxygen configuration file and parse its contents. In case of a failure in finding or loading the file, the variable DoxyUDT.Errr gets set in the constructor. It points to NULL (is empty) on success.

Currently only the first entry in a multi line tag gets parsed (just the first parameter of a lists).

Definition at line 46 of file fbdoc_doxyfile.bi.

Constructor & Destructor Documentation

DoxyUDT::DoxyUDT

(

BYREF_AS_STRING

Fnam

)

constructor loading and parsing a Doxyfile

Parameters

Fnam	The (path and) file name

The constructor tries to find, load and parse the Doxyfile. In case of failure the variable Errr contains an error message. Otherwise Errr is empty and the tags listed in enum DoxyTags get parsed from the Doxyfile by the member function Search().

Note

As in Doxygen, the second tag overrides the first.

This is a toy implementation. fb-doc doesn't read tag lists, it catches only the first entry of a list.

Definition at line 34 of file fbdoc_doxyfile.bas.

Here is the call graph for this function:

DoxyUDT::~DoxyUDT

(

)

destructor freeing the used memory

The destructor frees the memory (allocated in the constructor, if any).

Definition at line 96 of file fbdoc_doxyfile.bas.

Member Function Documentation

FUNCTION_AS_STRING DoxyUDT::Search	(	BYREF_AS_STRING	Su,
		BYREF_AS_INTEGER	Po
	)

find a single line tag in the Doxyfile and return its value

Parameters

Su	the tag to search for
Po	the position of the tag

Returns

the tags value (if any))

This function is designed to find the value of a Doxyfile tag. It returns the tag context, or an empty string if the tag has no value or cannot be found.

The Doxyfile is searched in reverse direction (from end to start), in order to find overrides first.

Note

In case of multi line values (ie. a list of paths) only the first entry gets returned.

Definition at line 132 of file fbdoc_doxyfile.bas.

Here is the caller graph for this function:

PROPERTY_AS_STRING DoxyUDT::Tag

(

BYVAL_AS_INTEGER

I

)

return a tag value

Parameters

I	the index of the tag to get

Returns

the tags value (if any)

This property returns the value of a Doxyfile tag. This is the context of the tag array at index I (an empty STRING if the tag has no value). Use enumerators DoxyTags for index values (since there's no error checking agianst index out of range).

Definition at line 111 of file fbdoc_doxyfile.bas.

Member Data Documentation

INTEGER DoxyUDT::Length

the length of the buffer

Definition at line 47 of file fbdoc_doxyfile.bi.

UBYTE_PTR DoxyUDT::Buffer

the buffer data

Definition at line 48 of file fbdoc_doxyfile.bi.

ZSTRING_PTR DoxyUDT::Doxy = "empty"

a pointer to interprete the data as STRING

Definition at line 50 of file fbdoc_doxyfile.bi.

STRING DoxyUDT::Errr

an error message (if any)

Definition at line 52 of file fbdoc_doxyfile.bi.

STRING DoxyUDT::Tags[XML_OUTPUT+1]

an array containing the tags context

Definition at line 52 of file fbdoc_doxyfile.bi.

---

The documentation for this class was generated from the following files:

• src/bas/fbdoc_doxyfile.bi
• src/bas/fbdoc_doxyfile.bas