dox.sh File Reference
Detailed Description
Create project documentation with Doxygen.
Generate Doxygen documentation from source code containing appropriate documentation tags. Customize the output to to eliminate unwanted warnings.
- Note:
- Using GENERATE_RTF=YES seems to cause the spurious message, "QGDict::hashAsciiKey: Invalid null key" on otherwise working and valid documentation. The reasons are not yet known, and it may be that the directive file needs some different settings.
- Todo:
- Identify reason for spurious message on RTF output as described above.
- Todo:
- A proper solution to old NetScape 4.7X processing the HTML tag <pre class="fragment"> syntax needs to be found and implemented so that <code> and @verbatim fragments, etc., may be displayed with proper framing and with proper newlines and white space. For the interim solution, see the end of this script. The problem will probably be solved by adjusting the doxygen.css (the default .css file) or supplying one that is customized for the project or perhaps just for old NetScape browsers. The scripts doxpatch.sh and doxunpatch.sh that support the interim solution might also be used in support of the proper solution if an "original" and a "patched" version of the style sheet exists in the HTML output directory. The alternative is to have an original and patched version of the HTML pages, which might be preferable, depending on the actual visual artifacts. In this case, a patch/unpatch script might either not be such a good idea or would be a bit more complex to implement. In any event, the correct approach is to find the HTML problem and fix it, probably in the style sheet.
- Todo:
- Perhaps the above to-do item should be generalized for the old NetScape 4.7X browser since is seems to have some overall problems with fonts in the default 'doxygen.css' style sheet. Perhaps someone with CSS experience could contribute one or more style sheets for use with different types of browsers so the HTML documents look the same on all of them.
- Todo:
- Consider the creation of a .css file that is customized especially for this project.
- Todo:
- A Windows .BAT version of this script needs to be written
- Bug:
- If the token sequence "@b @c word1 word2..." is used, two words get bolded instead of one (doxygen 1.4.4). Likewise with "@b @p word1 word2..." By reversing the sequence, only one word gets bolded. Is this a "bug" or a "feature"?
$URL: https://svn.apache.org/path/name/dox.sh $ $Id: dox.sh 0 09/28/2005 dlydick $
Copyright 2005 The Apache Software Foundation or its licensors, as applicable.
Licensed under the Apache License, Version 2.0 ("the License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and limitations under the License.
- Version:
- $LastChangedRevision: 0 $
- Date:
- $LastChangedDate: 09/28/2005 $
- Author:
- $LastChangedBy: dlydick $ Original code contributed by Daniel Lydick on 09/28/2005.
Definition in file dox.sh.
Go to the source code of this file.
Generated on Fri Sep 30 18:59:38 2005 by
1.4.4