Loading...
Searching...
No Matches
profilesDocUtils.h File Reference
+ Include dependency graph for profilesDocUtils.h:

Go to the source code of this file.

Functions

USDPROFILES_API std::string UsdProfilesMarkdown ()
 Markdown report of all capabilities and profiles in the registry, grouped by subgraph tag.
 
USDPROFILES_API std::string UsdProfilesMarkdown (const std::map< std::string, std::string > &styles)
 Markdown report (as above) with an embedded Mermaid diagram of the full capability DAG inserted before the Profiles section.
 
USDPROFILES_API std::string UsdProfilesMermaid (const std::map< std::string, std::string > &styles)
 Mermaid graph LR representation of the capability DAG.
 
USDPROFILES_API std::string UsdProfilesDot ()
 Graphviz DOT representation of the capability DAG.
 

Function Documentation

◆ UsdProfilesDot()

USDPROFILES_API std::string UsdProfilesDot ( )

Graphviz DOT representation of the capability DAG.

Same edge direction as the Mermaid form. Profiles get a doubled border; deprecated edges are dashed. Subgraph tags become cluster_<tag> subgraphs.

◆ UsdProfilesMarkdown() [1/2]

USDPROFILES_API std::string UsdProfilesMarkdown ( )

Markdown report of all capabilities and profiles in the registry, grouped by subgraph tag.

Two top-level sections:

Profiles

Capabilities

Each entry includes display name, id, docstring, and predecessors (with deprecation noted).

◆ UsdProfilesMarkdown() [2/2]

USDPROFILES_API std::string UsdProfilesMarkdown ( const std::map< std::string, std::string > & styles)

Markdown report (as above) with an embedded Mermaid diagram of the full capability DAG inserted before the Profiles section.

styles overrides registry styles per style-token; if empty, the registry's CapabilityStyles map is used.

◆ UsdProfilesMermaid()

USDPROFILES_API std::string UsdProfilesMermaid ( const std::map< std::string, std::string > & styles)

Mermaid graph LR representation of the capability DAG.

Edges run capability → predecessor; deprecated edges use a dashed link. Nodes carry a class derived from their style token, and Mermaid classDef lines are emitted from styles (or registry styles when empty). Subgraph tags are emitted as Mermaid subgraph clusters.