DOX{...} -- renders a URL for a Doxygen class diagram
- Parameters:
Parameter | Description | Default |
| Name of structure to link to | none, required parameter |
subdir | A simple subdirectory from the root | no subdirectory |
subdirs | Equivalent to CREATE_SUBDIRS parameter to Doxygen | DOXYGENPLUGIN_CREATE_SUBDIRS preference setting |
casesense | Equivalent to CASE_SENSE_NAMES parameter to Doxygen | DOXYGENPLUGIN_CASE_SENSE_NAMES preference setting |
stype | Structure type, e.g. "class", "struct", "union", etc. | class |
extension | File extension for Doxygen document. | .html |
This macro renders to a simple text string that is the concatenation of the following elements:
-
$Foswiki::cfg{Plugins}{DoxygenPlugin}{Root}
-
subdir
-
stype
- DEFAULT (this is the unnamed argument to the macro)
-
extension
Note: For security reasons,
subdir
only allows alphanumeric characters and underlines. This helps prevent malicious URLs from being generated.
Note: The URL is processed through the Doxygen character escaping algorithm, which replaces potentially problematic characters with coded text.
An example:
%DOX{"std::string" subdirs="1" subdir="stdcpp" casesense="0" stype="class"}%
Would generate (with the "Root" configuration item unset):
/stdcpp/d8/d29/classstd_1_1string.html
or, with the Root set to "http://www.google.com":
http://www.google.com/stdcpp/d8/d29/classstd_1_1string.html