Skip to content

Commit f0cadc9

Browse files
mpictormpictor
committed
add two files for doxyassist
1 parent 9c2018e commit f0cadc9

2 files changed

Lines changed: 315 additions & 0 deletions

File tree

‎doc/doxyassist.xml‎

Lines changed: 253 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,253 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<!-- run doxyassist from scl root dir:
3+
../doxyassist/doxyassist.py doc/doxyassist.xml -->
4+
5+
<!-- The main tag provides the version (1.0 only for now). The type attribute
6+
is not required, and defaults to "generic". To use a different project handler,
7+
change its type. The "name" attribute defines the name of your configuration.
8+
Note: you must define and use the "http://simply-life.net/doxyassist/project.xsd"
9+
namespace for the XML file to be processed properly. -->
10+
<DoxyAssist xmlns="http://simply-life.net/doxyassist/doxyassist.xsd"
11+
xmlns:da="http://simply-life.net/doxyassist/doxyassist.xsd"
12+
version="1.0" type="generic" name="My DoxyAssist Project">
13+
<!-- You can set global settings here. The doxyfile attribute defines the
14+
Doxyfile to load by default. If none is given, or the template cannot be
15+
loaded, the default Doxygen settings are used as base.
16+
17+
You can include any setting here, and it will be passed to Doxygen
18+
(even if it is not a recognized setting). You can add as many as you like,
19+
overriding the template or default Doxyfile.
20+
21+
The given template file will never be overwritten by Doxygen Assistant.
22+
Instead the project specific version will be kept in memory and written
23+
to Doxygen over a pipe.
24+
25+
Note that some settings are always overridden due to project definitions.
26+
See the information near the projects for more information. Changing these
27+
settings here will have no effect when using the Doxygen Assistant to
28+
run Doxygen. -->
29+
<doxygen doxyfile="./doc/Doxyfile">
30+
<!-- A boolean setting is defined like this. This will write "YES" or "NO" for
31+
the specific setting in the Doxyfile passed to Doxygen. -->
32+
<bool name="CREATE_SUBDIRS">false</bool>
33+
<!-- A numeric setting is written like this. It will be written to the Doxyfile
34+
without quotes. -->
35+
<int name="TAB_SIZE">8</int>
36+
<!-- This is a single string setting. When writing this out to the doxyfile,
37+
it will be quoted and treated as a whole. -->
38+
<string name="OUTPUT_LANGUAGE">English</string>
39+
<!-- A list setting contains multiple elements, seperated by whitespace. Each
40+
individual item will be quoted and treated as a whole for Doxygen. By
41+
default a list replaces the existing setting. If the append attribute is
42+
set to true, then the items will be added to the existing set. -->
43+
<string name="HTML_HEADER">./doc/doxygen_custom_header.html</string>
44+
<list name="FILE_PATTERNS" append="false">
45+
<item>*.h</item>
46+
<item>*.c</item>
47+
<item>*.hh</item>
48+
<item>*.cc</item>
49+
<item>README</item>
50+
</list>
51+
</doxygen>
52+
53+
<!-- Settings for the Qt Help Collection to create. If not present, no
54+
help collection will be created. See
55+
http://doc.trolltech.com/assistant-custom-help-viewer.html for a
56+
description of all settings; the inner configuration is copied directly
57+
into the <assistant> section of the project file.
58+
59+
The collectionFile attribute contains the path to the collection file to
60+
create (this file must be writable). Additionally provide the name for the
61+
project file in the projectFile attribute. By default this is the same
62+
as the collection file, with an extension of "qhcp" instead of "qhc"
63+
64+
The storage attribute defines the subdirectory to place copies of Qt
65+
Compressed Help files in. The copyAction attribute defaults to making
66+
actual copies; this attribute can be set to "copy", "move" and "symlink".
67+
-->
68+
<qtHelp collectionFile="./doc/helpcollection.qhc"
69+
projectFile="./doc/helpcollection.qhcp"
70+
storage="./doc/qch" copyAction="copy">
71+
<title>StepClassLibrary</title>
72+
<startPage>qthelp://com.github.mpictor/doc/index.html</startPage>
73+
<!-- See http://doc.trolltech.com/assistant-custom-help-viewer.html for more
74+
settings in the <assistant> section. -->
75+
</qtHelp>
76+
<!-- Start a list of projects -->
77+
<projects>
78+
<!-- A project contains information about one Doxygen run, as well as
79+
as well as subprojects. It can have its completely own Doxygen
80+
configuration.
81+
82+
Various settings are determined by the Doxygen Assistant; they will
83+
always override the Doxyfile settings. All values are by default inherited
84+
from the parent project, or empty if there is nothing to inherit from,
85+
unless noted otherwise. Note that even if a value is empty, this will
86+
override the Doxyfile settings. The following Doxyfile settings are
87+
overridden:
88+
- PROJECT_NAME
89+
- PROJECT_VERSION
90+
- INPUT
91+
- EXCLUDE
92+
- OUTPUT_DIRECTORY
93+
- WARN_LOGFILE
94+
- DOCSET_BUNDLE_ID
95+
- QCH_FILE
96+
- QHP_NAMESPACE
97+
- QHP_CUST_FILTER_NAME
98+
- QHP_CUST_FILTER_ATTRS
99+
- QHP_SECT_FILTER_ATTRS
100+
-->
101+
<project>
102+
<!-- The name of the project -->
103+
<name>StepClassLibrary</name>
104+
<!-- The version number of the documentation -->
105+
<version>0.2</version>
106+
<!-- Whether to build version specific documentation for the projects or not.
107+
Note that if this is set, Qt Help filters may become invalid when newer
108+
versions of the documentation are built. Due to user-specific settings,
109+
it may be necessary to remove the user specific cache files to reset
110+
the filters. It does however allow you to keep documentation of multiple
111+
versions next to each other. Default value is false.
112+
113+
Note that regardless of this setting, the version is still used in the
114+
PROJECT_NUMBER setting, as well as the PROJECT_NAME of subprojects -->
115+
<versionSpecific>false</versionSpecific>
116+
<!-- Full path to the directory with documented source code. You can add
117+
multiple input lines if you need to add multiple locations.
118+
119+
If you want documentation of subprojects to be explicitly included as well,
120+
you must list the EXACT same input directories in the parent; this
121+
will prevent the directories from being excluded. -->
122+
<input>./src</input>
123+
<input>./include</input>
124+
<exclude>./include/exppp</exclude>
125+
<exclude>./include/express</exclude>
126+
<!-- <input>./include/exppp</input>
127+
<input>./include/express</input>
128+
<input>./src/cldai</input>
129+
<input>./src/cleditor</input>
130+
<input>./src/clprobe-ui</input>
131+
<input>./src/clstepcore</input>
132+
<input>./src/clutils</input>
133+
<input>./src/exppp</input>
134+
<input>./src/express</input>
135+
<input>./src/fedex_plus</input>
136+
<input>./src/test</input>-->
137+
<!-- A list of files/paths to exclude. Add one <exclude> tag per path to
138+
exclude. This will automatically be expanded to exclude input directories
139+
of subprojects, and prevent mangled documentation. -->
140+
<!-- <exclude>/path/to/my-application/src/excluded</exclude> -->
141+
<!-- Directory to store Doxygen output for this project. Note that within
142+
this directory, a subdirectory is created based on the project name.
143+
Additionally, if the <versionspecific> setting has a value of true,
144+
another subdirectory based on the version number will be created (e.g.
145+
"/path/to/my-application/out/my-application/1.0". -->
146+
<output>./doc/doxygen</output>
147+
<!-- The directory where error and log files will be stored. Log and error
148+
files will be named "my-application.1-0.log" and
149+
"my-application.1-0-error.log" respectively. -->
150+
<logDirectory>./doc/doxygen/log</logDirectory>
151+
<!-- Optional base namespace for this application. This is prefixed to the
152+
normalized project name and version number (if version specific is set).
153+
The full namespace would now become "com.mycompany.my-application.1-0"
154+
in this example. -->
155+
<namespace>doc</namespace>
156+
<!-- You can define a <doxygen> block, in which you set project specific
157+
settings. This will hold for this and all subprojects. See also the
158+
<doxygen> block above. If you provide a doxyfile attribute, that
159+
file will be used as template instead; this also implies all settings
160+
in parent projects including the main doxygen settings will be
161+
discarded. -->
162+
<!-- <doxygen>
163+
<list name="FILE_PATTERNS" append="true">
164+
<item>*.module</item>
165+
<item>*.inc</item>
166+
<item>*.html</item>
167+
</list>
168+
</doxygen>-->
169+
170+
<!-- You can define subprojects here. Input directories of subprojects are
171+
automatically excluded from parent projects. As such, documentation will
172+
not be mixed.
173+
174+
Note that by default _all_ settings will be inherited from the parent.
175+
-->
176+
<project>
177+
<!-- The name of the subproject -->
178+
<name>CLStepCore</name>
179+
<version> </version>
180+
<!-- And its version -->
181+
<!-- <version>1.1</version> -->
182+
<!-- Whether to build version specific documentation for this subproject.
183+
If the parent is version specific, that setting will still be
184+
adhered to. If this is left out, the parent setting is inherited. -->
185+
<!-- <versionSpecific>false</versionSpecific> -->
186+
<!-- Full path to the directory with documented source code -->
187+
<input>./src/clstepcore</input>
188+
<!-- Subproject excluded directories -->
189+
<!-- <exclude>/path/to/my-application/src/mymodule/excluded</exclude> -->
190+
<!-- Optional output directory. If omitted, the parent project's output
191+
directory is inherited. The actual output is written to the same
192+
subdirectory of the parent project, in an extra subdirectory with a
193+
name based on the project name and optionally version. -->
194+
<!-- <output>/path/to/my-application/out</output> -->
195+
<!-- The optional log directory. If omitted, the parent project's log
196+
directory is inherited. Files will be named using project name and
197+
version number (if versionSpecific is true), including the parent
198+
project's information. Log and error files will, in this example,
199+
be named "my-application.1-0.my-module.log" and
200+
"my-application.1-0.my-module.err" respectively. -->
201+
<!-- <logDirectory>/path/to/my-application/doc/log</logDirectory> -->
202+
<!-- Additional part to prefix the project's subnamespace with. In this
203+
example, the namespace would become
204+
"com.mycompany.my-application.1-0.modules.my-module". -->
205+
<!-- <namespace>modules</namespace> -->
206+
<!-- You can add subprojects to subprojects as well, if you like -->
207+
</project>
208+
<project>
209+
<name>CLDAI</name>
210+
<version> </version>
211+
<input>./src/cldai</input>
212+
</project>
213+
<project>
214+
<name>CLEditor</name>
215+
<version> </version>
216+
<input>./src/cleditor</input>
217+
</project>
218+
<project>
219+
<name>CLProbe-ui</name>
220+
<version> </version>
221+
<input>./src/clprobe-ui</input>
222+
</project>
223+
<project>
224+
<name>CLUtils</name>
225+
<version> </version>
226+
<input>./src/clutils</input>
227+
</project>
228+
<project>
229+
<name>ExPPP</name>
230+
<version> </version>
231+
<input>./src/exppp</input>
232+
<input>./include/exppp</input>
233+
</project>
234+
<project>
235+
<name>Express</name>
236+
<version> </version>
237+
<input>./src/express</input>
238+
<input>./include/express</input>
239+
</project>
240+
<project>
241+
<name>Fedex Plus</name>
242+
<version> </version>
243+
<input>./src/fedex_plus</input>
244+
</project>
245+
<project>
246+
<name>Tests</name>
247+
<version> </version>
248+
<input>./src/test</input>
249+
</project>
250+
</project>
251+
<!-- And you can even add more top level projects to collect. -->
252+
</projects>
253+
</DoxyAssist>

‎doc/doxygen_custom_header.html‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<title>$title</title>
6+
<link href="$relpath$tabs.css" rel="stylesheet" type="text/css"/>
7+
<link href="$relpath$doxygen.css" rel="stylesheet" type="text/css" />
8+
$treeview
9+
$search
10+
$mathjax
11+
</head>
12+
<body>
13+
<div id="top"><!-- do not remove this div! -->
14+
<!--BEGIN TITLEAREA-->
15+
<div id="titlearea">
16+
<table cellspacing="0" cellpadding="0">
17+
<tbody>
18+
<tr style="height: 56px;">
19+
<!--BEGIN PROJECT_LOGO-->
20+
<td id="projectlogo"><img alt="Logo" src="$relpath$$projectlogo"></td>
21+
<!--END PROJECT_LOGO-->
22+
<!--BEGIN PROJECT_NAME-->
23+
<td style="padding-left: 0.5em;">
24+
<div id="projectname">$projectname
25+
<!--BEGIN PROJECT_NUMBER-->&#160;<span id="projectnumber">$projectnumber</span><!--END PROJECT_NUMBER-->
26+
</div>
27+
<!--BEGIN PROJECT_BRIEF--><div id="projectbrief">$projectbrief</div><!--END PROJECT_BRIEF-->
28+
</td>
29+
<!--END PROJECT_NAME-->
30+
<!--BEGIN !PROJECT_NAME-->
31+
<!--BEGIN PROJECT_BRIEF-->
32+
<td style="padding-left: 0.5em;">
33+
<div id="projectbrief">$projectbrief</div>
34+
</td>
35+
<!--END PROJECT_BRIEF-->
36+
<!--END !PROJECT_NAME-->
37+
<!--BEGIN DISABLE_INDEX-->
38+
<!--BEGIN SEARCHENGINE-->
39+
<td>$searchbox</td>
40+
<!--END SEARCHENGINE-->
41+
<!--END DISABLE_INDEX-->
42+
</tr>
43+
</tbody>
44+
</table>
45+
</div>
46+
<!--END TITLEAREA-->
47+
<!-- add module list -->
48+
<div id="navrow0" class="tabs">
49+
<ul class="tablist">
50+
<li><a href="../../doc.StepClassLibrary/doxygen-html/index.html"><span>Main</span></a></li>
51+
<li><a href="../../doc.StepClassLibrary.CLDAI/doxygen-html/index.html"><span>CLDAI</span></a></li>
52+
<li><a href="../../doc.StepClassLibrary.CLEditor/doxygen-html/index.html"><span>CLEditor</span></a></li>
53+
<li><a href="../../doc.StepClassLibrary.CLProbe-ui/doxygen-html/index.html"><span>CLProbe-ui</span></a></li>
54+
<li><a href="../../doc.StepClassLibrary.CLStepCore/doxygen-html/index.html"><span>CLStepCore</span></a></li>
55+
<li><a href="../../doc.StepClassLibrary.CLUtils/doxygen-html/index.html"><span>CLUtils</span></a></li>
56+
<li><a href="../../doc.StepClassLibrary.ExPPP/doxygen-html/index.html"><span>ExPPP</span></a></li>
57+
<li><a href="../../doc.StepClassLibrary.Express/doxygen-html/index.html"><span>Express</span></a></li>
58+
<li><a href="../../doc.StepClassLibrary.Fedex-Plus/doxygen-html/index.html"><span>Fedex-Plus</span></a></li>
59+
<li><a href="../../doc.StepClassLibrary.Tests/doxygen-html/index.html"><span>Tests</span></a></li>
60+
</ul>
61+
</div>
62+
<!-- end module list -->

0 commit comments

Comments
 (0)