Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
@paule32
paule32 committed Oct 21, 2024
1 parent b3cce78 commit 0a5dfd0
Show file tree
Hide file tree
Showing 20 changed files with 3,668 additions and 0 deletions.
9 changes: 9 additions & 0 deletions .gitignore
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@

chm/de/project_dark.chi
chm/de/project_dark.chm
chm/de/project_light.chi
chm/de/project_light.chm
chm/en/project_dark.chi
chm/en/project_dark.chm
chm/en/project_light.chi
chm/en/project_light.chm
36 changes: 36 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,42 @@ miniFPC Documentation
To view the Documentation as HTML Mark-Down, you can follow the Link:<br>
[click here](https://fpc.kallup.net). or as: [alternative](https://minifpc.github.io/doc/).

To create the Documentation on your own local Developer Domain, you can use the
shiped **build.bat** in this repro.

<pre>
D:\a\TinyRTL\TinyRTL\doc>build.bat
-[ remove old crap... ]-
-[ create new: de folders... ]-
-[ create new: en folders... ]-
-[ copy new: de files... ]-
-[ copy new: en files... ]-
-[ create de: dark chm file... ]-
-[ create de: light chm file... ]-
-[ create en: dark chm file... ]-
-[ create en: light chm file... ]-
-[ create de: dark htm file... ]-
-[ create de: light htm file... ]-
-[ create en: dark htm file... ]-
-[ create en: light htm file... ]-
-[ copy new de: chm files... ]-
-[ copy new en: chm files... ]-
-[ successfully build files... ]-

done.
</pre>
This can take a while. And you have the Environment variable **DOXYGEN_HH** together with
the latest **doxygen** distribution for your System (Windows) with working copy of
Microsoft HTML Help Compiler (which is part of HTML Workshop).

The result will be:
- 2 chm (Compiled Windows Help):
* dark style for English Developers
* light style
- 2 chm (Compiled Windows Help):
* dark style for German Developers
* light style

Have a nice Day<p>
Your miniFPC Team
</p>
276 changes: 276 additions & 0 deletions src/Doxyfile
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,276 @@
# ----------------------------------------------------------------------------
# File: Doxyfile
# Author: (c) 2024 Jens Kallup - paule32 non-profit software
# all rights reserved.
#
# optimized for: # Doxyfile 1.10.0
# ----------------------------------------------------------------------------
PROJECT_NAME = miniFPC - minimal FPC and RTL
PROJECT_NUMBER = 0.0.1
PROJECT_LOGO = D:/a/TinyRTL/TinyRTL/doc/logo.png

CHM_FILE = project_de.chm
OUTPUT_DIRECTORY = D:/a/TinyRTL/TinyRTL/doc/

OUTPUT_LANGUAGE = German
ENABLED_SECTIONS = german

HTML_HEADER = D:/a/TinyRTL/TinyRTL/doc/header.html
HTML_FOOTER = D:/a/TinyRTL/TinyRTL/doc/footer.html

HTML_EXTRA_STYLESHEET = D:/a/TinyRTL/TinyRTL/doc/Doxyfile.css

HHC_LOCATION = E:/doxygen/hhc/hhc.exe

DOXYFILE_ENCODING = "UTF-8"
ALLOW_UNICODE_NAMES = YES

GENERATE_HTML = YES
GENERATE_HTMLHELP = YES
GENERATE_TREEVIEW = NO
GENERATE_LATEX = NO
GENERATE_CHI = YES

HTML_OUTPUT = html
HTML_COLORSTYLE = DARK

#GENERATE_HIERARCHY = NO

INPUT += ./pas/mainpage.pas

BINARY_TOC = NO
TOC_EXPAND = NO

DISABLE_INDEX = YES
FULL_SIDEBAR = NO

BRIEF_MEMBER_DESC = YES
REPEAT_BRIEF = YES

FILE_PATTERNS = *.pas *.dpr

EXTENSION_MAPPING = pas=C++ dpr=C++ cc=C++ cpp=C++

ALIASES += colorText{2}="<span style='color:\1;'>\2</span>"

CREATE_SUBDIRS = YES
CREATE_SUBDIRS_LEVEL = 8

ALWAYS_DETAILED_SEC = YES
INLINE_INHERITED_MEMB = YES

FULL_PATH_NAMES = NO
SHORT_NAMES = NO

STRIP_FROM_PATH = YES
STRIP_FROM_INC_PATH = YES

MULTILINE_CPP_IS_BRIEF = NO

TAB_SIZE = 8

OPTIMIZE_OUTPUT_FOR_C = YES
OPTIMIZE_OUTPUT_JAVA = NO
OPTIMIZE_FOR_FORTRAN = NO

TOC_INCLUDE_HEADINGS = 5
AUTOLINK_SUPPORT = YES

BUILTIN_STL_SUPPORT = NO
CPP_CLI_SUPPORT = YES

SIP_SUPPORT = NO
IDL_PROPERTY_SUPPORT = YES

DISTRIBUTE_GROUP_DOC = YES
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
CASE_SENSE_NAMES = YES

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

HIDE_UNDOC_MEMBERS = NO
HIDE_UNDOC_CLASSES = NO
HIDE_UNDOC_RELATIONS = NO

HIDE_FRIEND_COMPOUNDS = NO
HIDE_IN_BODY_DOCS = NO
HIDE_SCOPE_NAMES = NO
HIDE_COMPOUND_REFERENCE = NO

INTERNAL_DOCS = YES

SHOW_HEADERFILE = NO
SHOW_INCLUDE_FILES = NO
SHOW_GROUPED_MEMB_INC = NO

FORCE_LOCAL_INCLUDES = NO

INLINE_INFO = NO

SORT_MEMBER_DOCS = YES
SORT_BRIEF_DOCS = YES
SORT_GROUP_NAMES = NO
SORT_BY_SCOPE_NAME = YES

STRICT_PROTO_MATCHING = NO

GENERATE_TESTLIST = NO
GENERATE_BUGLIST = NO
GENERATE_DEPRECATEDLIST = NO

MAX_INITIALIZER_LINES = 30

SHOW_FILES = NO
SHOW_USED_FILES = NO
SHOW_NAMESPACES = YES

FILE_VERSION_FILTER =
CITE_BIB_FILES =

RECURSIVE = NO

USE_MDFILE_AS_MAINPAGE =

SOURCE_BROWSER = NO
INLINE_SOURCES = NO

STRIP_CODE_COMMENTS = YES

REFERENCES_RELATION = YES
REFERENCES_LINK_SOURCE = NO

SOURCE_TOOLTIPS = NO
USE_HTAGS = NO
VERBATIM_HEADERS = NO

ALPHABETICAL_INDEX = YES

IGNORE_PREFIX =

ENUM_VALUES_PER_LINE = 4

HTML_FILE_EXTENSION = .html
HTML_CODE_FOLDING = NO
HTML_COPY_CLIPBOARD = NO

HTML_EXTRA_FILES =

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

TREEVIEW_WIDTH = 210

EXT_LINKS_IN_WINDOW = NO
OBFUSCATE_EMAILS = YES

HAVE_DOT = NO
DOT_PATH =
DIA_PATH =

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

USE_MATHJAX = NO

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

HTML_FORMULA_FORMAT = png

FORMULA_FONTSIZE = 10
FORMULA_MACROFILE =

EXTERNAL_GROUPS = YES
EXTERNAL_PAGES = YES

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

TAGFILES =
GENERATE_TAGFILE =
ALLEXTERNALS = NO

CLASS_GRAPH = YES
COLLABORATION_GRAPH = YES
GROUP_GRAPHS = YES

UML_LOOK = NO
UML_LIMIT_NUM_FIELDS = 10

DOT_UML_DETAILS = NO
DOT_WRAP_THRESHOLD = 17
DOT_CLEANUP = YES

TEMPLATE_RELATIONS = YES

INCLUDE_GRAPH = YES
INCLUDED_BY_GRAPH = YES

CALL_GRAPH = NO
CALLER_GRAPH = NO

GRAPHICAL_HIERARCHY = YES
DIRECTORY_GRAPH = YES
DIR_GRAPH_MAX_DEPTH = 5

DOT_IMAGE_FORMAT = png

DOT_GRAPH_MAX_NODES = 50
MAX_DOT_GRAPH_DEPTH = 100

GENERATE_LEGEND = YES
SEARCHENGINE = NO

# ----------------------------------------------------------------------------
# warning settings ...
# ----------------------------------------------------------------------------
QUIET = YES
WARNINGS = YES

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

0 comments on commit 0a5dfd0

Please sign in to comment.