DOXYDOT{...} -- 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
    gtype Type of diagram being linked to, "coll" (collaboration) or "inherit" (inheritance) coll
    style Graph type, e.g. "graph", "puml" graph (is used for Graphviz-generated diagrams while "puml" is used for PlantUML-generated diagrams)
    format Format of the image files being linked to, e.g. "png", "svg", etc. png

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)
  • "_"
  • gtype
  • "_"
  • style
  • "."
  • format

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:
%DOXYDOT{"std::string" subdirs="1" subdir="stdcpp" casesense="0" stype="class" gtype="inherit" style="graph" format="png"}%

Would generate (with the "Root" configuration item unset):
/stdcpp/classstd_1_1string_inherit_graph.png

or, with the Root set to "http://www.google.com":
http://www.google.com/stdcpp/classstd_1_1string_inherit_graph.png
Topic revision: r1 - 21 Oct 2016, JohnKnutson - This page was cached on 22 Oct 2018 - 11:58.

The copyright of the content on this website is held by the contributing authors, except where stated elsewhere. See Copyright Statement. Creative Commons License    Legal Imprint    Privacy Policy