- Q:
- How can I group a number of entries?
- A:
- Right as in this example:
/**@name comparison operators * / //@{ /// equal bool operator==(const Date& cmpDate); /// bool operator!=(const Date& cmpDate); /// less bool operator<(const Date& cmpDate); /// greater bool operator>(const Date& cmpDate); //@}- Q:
- How can I influence the order of the entries?
- A:
- The order of class members is the same as in the class declaration. The order of the entries in the table of contents is the order in which DOC++ reads the classes. Hence, typing ``doc++ *'' yields an alphabetically ordered list. You may also use ``//@Include:'' to read your files in the desired order.
- Q:
- How can I change fonts/borders/whatever in TeX output?
- A:
- Edit the file `docxx.sty' (there is no documentation about how to do this, sorry :-( ).
- Q:
- What do the blue and grey balls in the HTML-output mean?
- A:
- Entries that have a doc-string (not only memo) have a blue ball. Clicking on this ball gets you to the documentation.
- Q:
- How can I avoid scrolling all the way down to the class' documentation?
- A:
- Click on the class name to jump there.
- Q:
- How can I get other paper formats for the TeX output?
- A:
- Try the `-e' options. E.g.: with ``-eo a4paper'', the `a4paper' option will be set for the documentstyle; with ``-ep a4wide'' a ``\usepackage{a4wide}'' will be inserted before ``\begin{document}''. Finally, one can provide a completely own TeX environment setup using the `-ef' option.
- Q:
- I have the following:
/// class A { ... } a;Why do I get scrambled results ?- A:
- DOC++ does not know what you intend to document, the class A or the variable a. Solution: Split up class and variable declarations like this:
/// class A { ... }; /// A a;- Q:
- I have the following old C typedef:
/** ... */
typedef struct a { ... } a_t ;
Why do I get scrambled results?- A:
- This is the same problem as above. The solution is also equivalent:
/** ... */
struct a { ... };
/** ... */
typedef struct a a_t ;- Q:
- Is there a way to make the equation font larger in the HTML output?
- A:
- Sure, more than one. You may use ``\large'' or so within the equations. Or you may use the `-eo 12pt' option to render all GIFs in 12pt instead of 10pt. Or you may use you own TeX environment with `-ef' option to setup all fonts as desired.
- Q:
- Why does DOC++ fail to build GIFs for my formulae?
- A:
- There are two typical kinds of failure. One is, that you don't have setup your path to find the `ppmtools', `gs' or `latex'. The other is that `latex' fails to process your formulae. Check the file `dxxgifs.tex' in your html directory to see what LaTeX tries to process.
Alphabetic index Hierarchy of classes