DOXYGEN VERILOG HOW TO
DOXYGEN VERILOG UPDATE

critical ( msg, ansi_fmt='31 1m', output_stream=' mode='w' encoding='utf-8'> )  exhale.utils. info ( msg, ansi_fmt='34 1m', output_stream=' mode='w' encoding='utf-8'> )  exhale.utils. progress ( msg, ansi_fmt='32 1m', output_stream=' mode='w' encoding='utf-8'> )  exhale.utils. The message msg in color, or not, depending on both output_stream (file)Īssumed to be either sys.stdout or sys.stderr. The ANSI color format to use when coloring is supposed to happen. The message that is going to be printed by the caller of this method. Non-colorized output when output_stream is not a TTY (e.g. _use_color ( msg, ansi_fmt, output_stream ) īased on alwaysColorize, returns the colorized or colorize ( msg, ansi_fmt )  exhale.utils. Wrapper call to indent() with an always-true predicate so thatĮmpty lines (e.g. It will default to adding ‘prefix’ to all non-empty lines that do notĬonsist solely of whitespace characters. If ‘predicate’ is provided, ‘prefix’ will only be added to the lines This is a direct copy of textwrap.indent for availability in Python 2.Īdds ‘prefix’ to the beginning of selected lines in ‘text’. indent ( text, prefix, predicate = None ) 

DOXYGEN VERILOG HOW TO

The definitions below only affect theįoreground color of the text, but you can easily change the background color too.įor a concise overview of how to use the ANSI color codes. AnsiColors Ī simple wrapper class for convenience definitions of common ANSI formats to enableĬolorizing output in various formats.

DOXYGEN VERILOG UPDATE

Update docs for new list version rather than string returns class exhale.utils. The empty string is returnedįor both unrecognized and ignored input values. The directive to be used for the given kind. The kind of the breathe compound / ExhaleNode object (same values). Returns the appropriate breathe restructured text directive for the specified kind. If the empty string is returned then it was not

The qualifying string that will be used to build the reStructuredText titles and The return value of a Breathe compound object’s get_kind() method. Note also that although a return value is generated, neither “enumvalue” nor The output for a given kind is as follows:

in generated file headings and link names). Qualifies the breathe kind and returns an qualifier string describing this nodeCompoundXMLContents ( node )  exhale.utils. The single character being used for this heading, e.g. The title that is being underlined, length assumed to be >= 1. Given an input title and character, creates the reStructuredText underlineĪccording to the length of the title. Return dictĪ dictionary where the keys are every value inĪVAILABLE_KINDS, and the values are the listĬleanup / reorder these exhale.utils. The empty list indicates to use the Breathe defaults. Parameters func (types.FunctionType)Ī callable function that takes as input a string fromĪVAILABLE_KINDS and returns a list of strings. makeCustomSpecificationsMapping ( func ) Ĭreates the “pickleable” dictionary that will be used withĬustomSpecificationsMapping supplied to exhale_args in Breathe Customization Support  exhale.utils. The kind of the compound (one of AVAILABLE_KINDS). contents:: directives according to the rules outlined in

'dir', 'file', and 'namespace' since they require special treatment.Įxhale.utils. 'enumvalue' and 'group' (unused in framework), and Is everything in AVAILABLE_KINDS, except for This more or less corresponds to the kinds that Exhale uses a Breathe directive. LEAF_LIKE_KINDS = Īll kinds that can be generated using ExhaleRoot.generateSingleNodeRST. The 'group' and 'enumvalue' kinds are currently detected, but unused. AVAILABLE_KINDS = Īll potential input kind values coming from Doxygen.

Doxygen verilog