HELP - LayoutHtml
HelpConfig OptionsLayoutHtml
Description  
Configuration options related to the HTML layout.
NAVIGATION_CHAR_LENGTHThe NAVIGATION_CHAR_LENGTH tag is the maximum of charters there must bebefore we are cuttingThis is done to prevent the left menu from taking op to much space
Default value:
25
LIMIT_COMPACT_IN_OVERVIEW_TABLESIf the number of entries in an overview table exceeds this number, then the the table will be shown in compact mode. Compact mode means that the table will contain COLS_IN_OVERVIEW_TABLES coloumns in each row and only the definitions name will be shown. The brief description will be be shown via mouse over effect.
Default value:
100
COLS_IN_OVERVIEW_TABLESNumber of coloumns in all the overview tables in case some of them contains so many elements that they need to swich to compact mode.
Default value:
4
LIMIT_ALFA_INDEX_IN_OVERVIEW_TABLESIf the number of entries in an overview table exceeds this number, then the the an alphabetical index will be generated.
Default value:
200
COMPACT_CHAR_LENGTHThe COMPACT_CHAR_LENGTH tag is the maximum of charters there must bebefore we are cutting the name in compact modeThis is done to prevent the name from being to long
Default value:
25
INFO_ON_OVERVIEW_TABLES_NORMALEnables the info icon (mouse over popup) in non compact mode (ie. tables with brief description).A mouse over popup will be shown with same type of info as on diagrams. Brief, public members etc.
Default value:
YES
INFO_ON_OVERVIEW_TABLES_COMPACTEnables the info icon (mouse over popup) in compact mode (ie. tables with no brief description).A mouse over popup will be shown with same type of info as on diagrams. Brief, public members etc.
Default value:
YES
INFO_ON_CODE_LINKSEnables info (mouse over popup) on all hyperlinks made to entities found in examples and in source code views. Note that here the info icon is omitted and instead the entire hyperlink has the mouse over. This is to keep the code views from being cluttered with tiny images that would ruin indention and make the code harder to read. A mouse over popup will be shown with same type of info as on diagrams. Brief, public members etc.
Default value:
YES
INCLUDE_BRIEF_IN_HEADERIf true the brief description is included in the header of the description. If both this tag and INCLUDE_BRIEF_IN_DESCRIPTION are set to NO then brief description will not appear on the decription pages.
Default value:
YES
INCLUDE_BRIEF_IN_DESCRIPTIONIf true the brief description is repeated in the description section.If both this tag and INCLUDE_BRIEF_IN_HEADER are set to NO then brief description will not appear on the decription pages.
Default value:
YES
HIDE_TYPE_ON_DESCRIPTIONIf true the desciption will not contain type info.Ex:(Page),(Class),(Namespace).
Default value:
NO
EXPAND_COLLAPSE_SECTIONSEnables the collapse / expand icons on the description page.All sections can now be collapsed. See also EXPAND_COLLAPSE_TABLE_SECTIONS_ONLY
Default value:
YES
EXPAND_COLLAPSE_TABLE_SECTIONS_ONLYEnables the collapse / expand icons on syntax, parameters etc.This tag depends on EXPAND_COLLAPSE_SECTIONS is set to YES.If this is set to true, then only syntax/parameters, reimplements etc. sections will have expand collapse icons. Description, todo, etc. cannot be collapsed.
Default value:
YES
CENTER_ALIGN_IMAGESIf set to YES, then included images (and their captions) are centered. Otherwise the images and captions will be left-aligned.
Default value:
NO
OPTIMIZE_OUTPUT_FOR_CIf set to YES, DoxyS make some C related enhancements. For now it's not so much, but still nice for pure C code.
Default value:
NO
SHOW_PATH_IN_HEADERIf set to YES, DoxyS will make a path in the header. You can get an overview over where you are in the project and navigate in the path.
Default value:
YES
FUNCTION_POINTER_NAMESet this to non empty string if you want a different name for 'function pointer' like e.g. 'callback'.
FUNCTION_POINTERS_NAMESet this to non empty string if you want a different name for 'function pointers' (plural) like e.g. 'callbacks'.
EXAMPLES_USE_TABSIf set to YES, DoxyS will display examples on all pages as tabs. If set to NO examples will be shown (classical) using expand/collapse icons. See also EXAMPLE_GROUP_USE_TABS.
Default value:
YES
EXAMPLE_GROUP_USE_TABSIf set to YES, DoxyS will display examples on the 'examples' directory-tab as tabs instead of the DoxyS classical overview table style. See also EXAMPLES_USE_TABS.
Default value:
YES
CONTENT_FRAME_USE_SLIDERIf set to YES the main content 'frame' will use it's own (vertical) slider which makes good sense combined with the left menu as a tree. If set to false page just scrolls using browsers default right scrollbar.
Default value:
YES