File: format.el.html

Once a language file has been parsed into a TAG, it is often useful then display that tag information in browsers, completion engines, or help routines. The functions and setup in this file provide ways to reformat a tag into different standard output types.

In addition, macros for setting up customizable variables that let the user choose their default format type are also provided.

Defined variables (10)

semantic-format-face-alistFace used to colorize tags of different types.
semantic-format-parent-separatorText used to separate names when between namespaces/classes and functions.
semantic-format-tag-custom-listA List used by customizable variables to choose a tag to text function.
semantic-format-tag-functionsList of functions which convert a tag to text.
semantic-format-tag-protection-image-alistAssociation of protection strings, and images to use.
semantic-format-tag-protection-symbol-to-string-assoc-listAssociation list of the form (SYMBOL . "STRING") for protection symbols.
semantic-format-use-images-flagNon-nil means semantic format functions use images.
semantic-function-argument-separatorText used to separate arguments when creating text from tags.
semantic-uml-colon-stringString used as a color separator between parts of a UML string.
semantic-uml-no-protection-stringString used to describe when no protection is specified.

Defined functions (36)

semantic--format-colorize-merge-text(PRECOLOREDTEXT FACE-CLASS)
semantic--format-colorize-text(TEXT FACE-CLASS)
semantic--format-tag-arguments(ARGS FORMATTER COLOR)
semantic--format-tag-parent-tree(TAG PARENT)
semantic--format-tag-uml-type(TAG COLOR)
semantic--format-uml-post-colorize(TEXT TAG PARENT)
semantic-format-tag-abbreviate(TAG &optional PARENT COLOR)
semantic-format-tag-abbreviate-default(TAG &optional PARENT COLOR)
semantic-format-tag-canonical-name(TAG &optional PARENT COLOR)
semantic-format-tag-canonical-name-default(TAG &optional PARENT COLOR)
semantic-format-tag-concise-prototype(TAG &optional PARENT COLOR)
semantic-format-tag-concise-prototype-default(TAG &optional PARENT COLOR)
semantic-format-tag-name(TAG &optional PARENT COLOR)
semantic-format-tag-name-default(TAG &optional PARENT COLOR)
semantic-format-tag-name-from-anything(ANYTHING &optional PARENT COLOR COLORHINT)
semantic-format-tag-prin1(TAG &optional PARENT COLOR)
semantic-format-tag-prototype(TAG &optional PARENT COLOR)
semantic-format-tag-prototype-default(TAG &optional PARENT COLOR)
semantic-format-tag-short-doc(TAG &optional PARENT COLOR)
semantic-format-tag-short-doc-default(TAG &optional PARENT COLOR)
semantic-format-tag-summarize(TAG &optional PARENT COLOR)
semantic-format-tag-summarize-default(TAG &optional PARENT COLOR)
semantic-format-tag-summarize-with-file(TAG &optional PARENT COLOR)
semantic-format-tag-summarize-with-file-default(TAG &optional PARENT COLOR)
semantic-format-tag-type(TAG COLOR)
semantic-format-tag-type-default(TAG COLOR)
semantic-format-tag-uml-abbreviate(TAG &optional PARENT COLOR)
semantic-format-tag-uml-abbreviate-default(TAG &optional PARENT COLOR)
semantic-format-tag-uml-concise-prototype(TAG &optional PARENT COLOR)
semantic-format-tag-uml-concise-prototype-default(TAG &optional PARENT COLOR)
semantic-format-tag-uml-protection(TAG PARENT COLOR)
semantic-format-tag-uml-protection-to-string(PROTECTION-SYMBOL COLOR)
semantic-format-tag-uml-protection-to-string-default(PROTECTION-SYMBOL COLOR)
semantic-format-tag-uml-prototype(TAG &optional PARENT COLOR)
semantic-format-tag-uml-prototype-default(TAG &optional PARENT COLOR)
semantic-uml-attribute-string(TAG &optional PARENT)

Defined faces (0)