create Table of Contents (TOC) in a CHM Project and HowTo sort struct by occurency, not Name ? #11530

paule32 · 2025-04-05T10:15:06Z

paule32
Apr 5, 2025

Hello,
how can I:

documenting "struct"s in the order of occurency, not name ?
create a Table of Contents for CHM Output ?

packed.zip

albert-github · 2025-04-05T10:30:06Z

albert-github
Apr 5, 2025
Collaborator

Which version of doxygen are you using?
Did you have a look at the SORT_... settings?
Where do you want to see the tTable of contents in the CHM output?
- did you have a look at the command \tableofcontents?

4 replies

paule32 Apr 5, 2025
Author

I have done the sorting issue.
But I don't know, how to use \tableofcontents
The mainpage.doc is follows.

/**
 * @file:   mainpage.doc
 * @author: (c) 2025 Jens Kallup - \a_currentAuthors
 *          All rights reserved
 *
 * \cond english
 * \brief only for education, and non-profit usage !
 * \endcond
 *
 * \cond german
 * \brief nur für Bildungszwecke, und non-profit Nutzung !
 * \endcond
 */

/**
 * \cond german
 * @mainpage miniFPC/RTL
 *
 * Herzlich Willkommen auf der Hauptseite des miniFPC/RTL Projektes !
 * Diese Dokumentation enthält Informationen zur Anwendung/Bibliothek.
 * \endcond
 *
 * \cond english
 * @mainpage miniFPC/RTL
 *
 * Welcome on the landing page for the miniFPC/RTL Project !
 * This Documentation contains Informations for the Application/Library.
 * \endcond
 */

/**
 * \tableofcontents
 * Leading text.
 * \section sec An example section
 * This page contains the subsections \ref subsection1 and \ref subsection2.
 * For more info see page \ref page2.
 * \subsection subsection1 The first subsection
 * Text.
 * \subsection subsection2 The second subsection
 */

And This is the Output Screen:

paule32 Apr 5, 2025
Author

I am use: 1.13.1 (cb7d0d0)

albert-github Apr 5, 2025
Collaborator

In the example you now preset I see an extra section (starting with \tableofcontents) but this section is not connected to anything, when you remove e.g. the just preceding part:

 */

/**

you will see a table of contents.

paule32 Apr 5, 2025
Author

Now, I have remove the Line:
LAYOUT_FILE =
#./Doxyfile.Server.Layout

Then, the TOC will be display in the left Window.
But with the Config:

I get this Output (Screen/Image) - the struct will not to be documented;
From fpcDLL.h:

/**
 * \struct TDLLerror
 * \cond   english
 * \brief  The following structure is the main struct for exchange errors from C++
 *         and FPC.
 *
 * This structure is used for the Exchange of Error Codes, Messages, and Debug
 * Informations from C++ to FPC, and FPC to C++.
 * \endcond
 */
struct TDLLerror {
	uint32_t ErrorCode;                 ///< \cond english The Error Code of current Error   \endcond
	uint32_t ErrorTextLength;           ///< \cond english The Length for ErrorText          \endcond
	uint32_t ErrorFromFunctionLength;   ///< \cond english The Length for the Function Name  \endcond
	uint32_t ErrorFromLine;             ///< \cond english The Line of Error occurency       \endcond
	char*    ErrorText;                 ///< \cond english The Error Text                    \endcond
	char*    ErrorTimeStamp[32];        ///< \cond english A Time stamp for the Error        \endcond
	char*    ErrorFromFunction;         ///< \cond english This is the Function name in which the Error occur \endcond
};

and the settings File:

PROJECT_NAME           = "miniFPC/RTL - Minimal FPC/RTL"
PROJECT_NUMBER         = "0.0.1 RC 0.1"
PROJECT_BRIEF          = "(c) 2025 by Jens Kallup - paule32 & Fibonacci."
PROJECT_LOGO           = ./doc/img/logo.png

DOXYFILE_ENCODING      = UTF-8
OUTPUT_LANGUAGE        = English

TAGFILES               = customtags.txt=./

ENABLED_SECTIONS       = english
ALLOW_UNICODE_NAMES    = YES

OUTPUT_DIRECTORY       = ./dox
HTML_OUTPUT            = html

HTML_COLORSTYLE        = DARK

GENERATE_HTML          = YES
GENERATE_HTMLHELP      = YES
GENERATE_CHI           = NO

INTERACTIVE_SVG        = NO

BRIEF_MEMBER_DESC      = YES
REPEAT_BRIEF           = YES

INPUT                  = \
    ./doc/mainpage.doc \
    ../mfcFPC/mfcFPC.h \
    ../mfcFPC/fpcDLL.h \
    ../mfcFPC/RTL.cpp

# ----------------------------------------------------------------------------
CHM_FILE               = devdoc.chm
HHC_LOCATION           = "C:/Program Files (x86)/HTML Help Workshop/hhc.exe"

HTML_HEADER            = 
HTML_FOOTER            = ./Doxyfile.Server.chm.footer
HTML_STYLESHEET        = 

HTML_EXTRA_STYLESHEET  = ./Doxyfile.Server.chm.css
HTML_EXTRA_FILES       =

LAYOUT_FILE            = 
#./Doxyfile.Server.Layout

# ----------------------------------------------------------------------------
# customized tags ...
# ----------------------------------------------------------------------------
ALIASES += a_colortext{2}="\htmlonly <font color='%1'><b>%2</b></font>\endhtmlonly"
ALIASES += a_colorYellow{1}="\htmlonly <font color='yellow'>%1</font>\endhtmlonly"

ALIASES += myproject="Project 0.1"
ALIASES += fcolor{2}="\htmlonly <font color='%1'>%2</font> \endhtmlonly"

ALIASES += a_currentVersion="Version 0.0.1"
ALIASES += a_currentAuthors="paule32 & fibonacci"

ALIASES += "english=\if english" \
           "endenglish=\endif"   \
           "german=\if german"   \
           "endgerman=\endif"

INPUT_ENCODING         = UTF-8
INPUT_FILE_ENCODING    =

CREATE_SUBDIRS         = YES
CREATE_SUBDIRS_LEVEL   = 8

ABBREVIATE_BRIEF       = "The $name class" \
                         "The $name widget" \
                         "The $name file" \
                         is \
                         provides \
                         specifies \
                         contains \
                         represents \
                         a \
                         an \
                         the

ALWAYS_DETAILED_SEC    = YES
INLINE_INHERITED_MEMB  = YES
FULL_PATH_NAMES        = NO

# no no
STRIP_FROM_PATH        = YES
STRIP_FROM_INC_PATH    = YES
SHORT_NAMES            = NO

MULTILINE_CPP_IS_BRIEF = NO
INHERIT_DOCS           = YES
SEPARATE_MEMBER_PAGES  = NO

TAB_SIZE               = 8

OPTIMIZE_OUTPUT_FOR_C  = YES
OPTIMIZE_OUTPUT_JAVA   = NO
OPTIMIZE_FOR_FORTRAN   = YES

EXTENSION_MAPPING      = pas=C++ pp=C++ inc=C++
FILE_PATTERNS          = *.c   *.cc *.cxx *.cpp *.c++ \
                         *.h   *.hh *.hxx *.hpp *.h++ \
                         *.pas *.pp *.inc

TOC_INCLUDE_HEADINGS   = 5
AUTOLINK_SUPPORT       = NO
BUILTIN_STL_SUPPORT    = NO
CPP_CLI_SUPPORT        = YES

SIP_SUPPORT            = NO
IDL_PROPERTY_SUPPORT   = YES

DISTRIBUTE_GROUP_DOC   = NO
GROUP_NESTED_COMPOUNDS = NO
SUBGROUPING            = YES

INLINE_GROUPED_CLASSES = NO
INLINE_SIMPLE_STRUCTS  = NO

TYPEDEF_HIDES_STRUCT   = NO

LOOKUP_CACHE_SIZE      = 0
NUM_PROC_THREADS       = 1

EXTRACT_ALL            = YES
EXTRACT_PRIVATE        = NO
EXTRACT_PRIV_VIRTUAL   = NO
EXTRACT_PACKAGE        = NO
EXTRACT_STATIC         = YES
EXTRACT_LOCAL_CLASSES  = YES
EXTRACT_LOCAL_METHODS  = YES
EXTRACT_ANON_NSPACES   = YES

RESOLVE_UNNAMED_PARAMS = YES

HIDE_UNDOC_MEMBERS     = NO
HIDE_UNDOC_CLASSES     = NO
HIDE_FRIEND_COMPOUNDS  = NO
HIDE_IN_BODY_DOCS      = NO

INTERNAL_DOCS          = YES

CASE_SENSE_NAMES       = NO

HIDE_SCOPE_NAMES       = NO
HIDE_COMPOUND_REFERENCE= NO

SHOW_HEADERFILE        = NO
SHOW_INCLUDE_FILES     = NO
SHOW_GROUPED_MEMB_INC  = NO

FORCE_LOCAL_INCLUDES   = NO

# yes
INLINE_INFO            = NO

SORT_MEMBER_DOCS       = NO
SORT_BRIEF_DOCS        = NO
SORT_MEMBERS_CTORS_1ST = NO
SORT_GROUP_NAMES       = NO
SORT_BY_SCOPE_NAME     = NO

STRICT_PROTO_MATCHING  = NO

GENERATE_TODOLIST       = YES
GENERATE_TESTLIST       = YES
GENERATE_BUGLIST        = YES
GENERATE_DEPRECATEDLIST = YES

MAX_INITIALIZER_LINES  = 30

SHOW_USED_FILES        = YES
# yes
SHOW_FILES             = NO
SHOW_NAMESPACES        = YES

FILE_VERSION_FILTER    =
CITE_BIB_FILES         =

RECURSIVE              = NO

EXCLUDE                =
EXCLUDE_SYMLINKS       = NO
EXCLUDE_PATTERNS       =
EXCLUDE_SYMBOLS        =

EXAMPLE_PATH           = ./doc/examples
EXAMPLE_PATTERNS       = *
EXAMPLE_RECURSIVE      = NO

IMAGE_PATH             = ./doc/img

INPUT_FILTER           =

FILTER_PATTERNS        =
FILTER_SOURCE_FILES    = NO
FILTER_SOURCE_PATTERNS =

USE_MDFILE_AS_MAINPAGE =

# yes
SOURCE_BROWSER         = NO
INLINE_SOURCES         = NO
STRIP_CODE_COMMENTS    = NO

REFERENCED_BY_RELATION = NO

REFERENCES_RELATION    = NO

#yes
REFERENCES_LINK_SOURCE = NO

#yes
SOURCE_TOOLTIPS        = NO
USE_HTAGS              = NO
VERBATIM_HEADERS       = NO

ALPHABETICAL_INDEX     = YES

IGNORE_PREFIX          =

HTML_FILE_EXTENSION    = .html

HTML_CODE_FOLDING      = NO
HTML_COPY_CLIPBOARD    = NO

HTML_COLORSTYLE_HUE    = 220
HTML_COLORSTYLE_SAT    = 100
HTML_COLORSTYLE_GAMMA  = 80

HTML_DYNAMIC_MENUS     = NO
HTML_DYNAMIC_SECTIONS  = NO

HTML_INDEX_NUM_ENTRIES = 100

GENERATE_LATEX         = NO

HAVE_DOT               = YES
DOT_PATH               = "C:/Programme/Graphviz/bin/dot.exe"
DIA_PATH               =

BINARY_TOC             = NO
TOC_EXPAND             = NO

DISABLE_INDEX          = NO
GENERATE_TREEVIEW      = YES
FULL_SIDEBAR           = NO

ENUM_VALUES_PER_LINE   = 4
TREEVIEW_WIDTH         = 250

EXT_LINKS_IN_WINDOW    = NO
OBFUSCATE_EMAILS       = YES

HTML_FORMULA_FORMAT    = png

FORMULA_FONTSIZE       = 10
FORMULA_MACROFILE      =

USE_MATHJAX            = NO

MATHJAX_VERSION        = MathJax_2
MATHJAX_FORMAT         = HTML-CSS
MATHJAX_RELPATH        =
MATHJAX_EXTENSIONS     =
MATHJAX_CODEFILE       =

SEARCHENGINE           = NO

SERVER_BASED_SEARCH    = NO
EXTERNAL_SEARCH        = NO

EXTERNAL_SEARCH_ID     =
EXTRA_SEARCH_MAPPINGS  =

GENERATE_AUTOGEN_DEF   = NO

ENABLE_PREPROCESSING   = YES
MACRO_EXPANSION        = YES
EXPAND_ONLY_PREDEF     = NO

SEARCH_INCLUDES        = NO
INCLUDE_PATH           =
INCLUDE_FILE_PATTERNS  =
PREDEFINED             =
EXPAND_AS_DEFINED      =
SKIP_FUNCTION_MACROS   = YES

GENERATE_TAGFILE       = YES
ALLEXTERNALS           = NO
EXTERNAL_GROUPS        = YES
EXTERNAL_PAGES         = YES

HIDE_UNDOC_RELATIONS   = NO
DOT_NUM_THREADS        = 0

DOT_COMMON_ATTR        = "fontname=FreeSans,fontsize=10"
DOT_EDGE_ATTR          = "labelfontname=FreeSans,labelfontsize=10"
DOT_NODE_ATTR          = "shape=box,height=0.2,width=0.4"
DOT_FONTPATH           =

CLASS_GRAPH            = NO
COLLABORATION_GRAPH    = NO
GROUP_GRAPHS           = NO

UML_LOOK               = NO
UML_LIMIT_NUM_FIELDS   = 10

DOT_UML_DETAILS        = YES
DOT_WRAP_THRESHOLD     = 17

TEMPLATE_RELATIONS     = YES

INCLUDE_GRAPH          = YES
INCLUDED_BY_GRAPH      = YES

CALL_GRAPH             = NO
CALLER_GRAPH           = NO

GRAPHICAL_HIERARCHY    = NO
DIRECTORY_GRAPH        = NO
DIR_GRAPH_MAX_DEPTH    = 1

DOT_IMAGE_FORMAT       = png

DOTFILE_DIRS           = ./doc/dot
MSCFILE_DIRS           =
DIAFILE_DIRS           =

DOT_GRAPH_MAX_NODES    = 50
MAX_DOT_GRAPH_DEPTH    = 1000
DOT_MULTI_TARGETS      = NO
GENERATE_LEGEND        = YES

DOT_CLEANUP            = YES


# ----------------------------------------------------------------------------
# Warning settings
# ----------------------------------------------------------------------------
QUIET                  = YES
WARNINGS               = YES

WARN_IF_UNDOCUMENTED   = NO
WARN_IF_DOC_ERROR      = YES
WARN_IF_INCOMPLETE_DOC = YES
WARN_NO_PARAMDOC       = NO
WARN_IF_UNDOC_ENUM_VAL = NO
WARN_AS_ERROR          = NO
WARN_FORMAT            = "$file:$line: $text"
WARN_LINE_FORMAT       = "at line $line of file $file"
WARN_LOGFILE           = warnings.log

albert-github · 2025-04-05T13:27:42Z

albert-github
Apr 5, 2025
Collaborator

I don't think the 2 questions (table of contents and struct) you mentioned here are related, so please make a separate question for the struct question. The fact that the struct is not shown is logical as we see in the layout file <tab type="structs" visible="no" title=""> and when you remove this line / part from the layout file the default will be used and this is visible="yes".

0 replies

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

create Table of Contents (TOC) in a CHM Project and HowTo sort struct by occurency, not Name ? #11530

Uh oh!

{{title}}

Uh oh!

Replies: 2 comments 4 replies

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Select a reply

Uh oh!

create Table of Contents (TOC) in a CHM Project and HowTo sort struct by occurency, not Name ? #11530

Uh oh!

paule32 Apr 5, 2025

Replies: 2 comments · 4 replies

Uh oh!

albert-github Apr 5, 2025 Collaborator

Uh oh!

paule32 Apr 5, 2025 Author

Uh oh!

paule32 Apr 5, 2025 Author

Uh oh!

albert-github Apr 5, 2025 Collaborator

Uh oh!

paule32 Apr 5, 2025 Author

Uh oh!

albert-github Apr 5, 2025 Collaborator

paule32
Apr 5, 2025

Replies: 2 comments 4 replies

albert-github
Apr 5, 2025
Collaborator

paule32 Apr 5, 2025
Author

paule32 Apr 5, 2025
Author

albert-github Apr 5, 2025
Collaborator

paule32 Apr 5, 2025
Author

albert-github
Apr 5, 2025
Collaborator