Things to do
- Have option for menu style
See Contents on http://www.doctypes.org/doc/gw/ How?
In general see how close one get get to this page layout? (and how easy it is:)
- ``C'' mode?
- more user macros
Section name HTML-CODE with $0 ...
@name args
...
@end name
Define x(a,b,c) d4c code with $a ...
@frac{a}{b} -> {{a} OVER {b}} (will have to interfere with input)
Define x(a,b,c) HTML code
- images are not deleted automatically.
- directory level preferences?
- Directory level @value?
May come in directory level preferences, when we have them
- class contents
typedefs, methods etc, in same style as directory level contents.
when?
- When class is big. User specifies what is big. number of elemenets? number of public elemenets?
- when user asks specific for class.
where?
- have class file point to context page
- can we pre-define some values
- @value{directory} directory name
- @value{file} file name
- @value{class} class name (in class documentation)
- texinfo
- handle @include
- do menu *name: loc desc in texi
- do @def... stuff
- correct line numbers in texi
- can make `@printindex fn' into pointer to index?
- coalesce with `@syncodeindex'
- can we decide if we want info or html sections?
- indices
- support adding to any index
- Can we read man pages?
- read Frame mif?
- do we want to print initializing arrays? give global option? how to give as local option?
Interface/Implementation distinction should apply only to contents pages (TOC).
Classify file as interface or implementation. default interface.
An element inherits it's classification from the file?.
a method outside a class is implementation. in class interface. a function/class/etc in interface file - interface, otherwise implementation.
resolve reference ambiguity in favor of interface. have an interface/implementation choise in setprot.
how to give a reference to interface from implementation? how to give a reference to implementation from contents? what about files, classes etc that has nothing but implementation? how to explicitly specify a reference to implementation?
an implementation class should not be in the menues. but its pages should be the same.
It is hard to see how to make one book out of the hierarchal structure of documentation. On the other hand, making a printout of a file source where chapters and top topics are filtered and printed separately, and some d4c&b comments are converted to something more readable would be nice.
If we generate texinfo, we can use makeinfo (useless, but may be the easy way to check generated files), texi2roff for printing and tex.
Issues:
- What to do with ref? give relative file name if not in this file? line number?
- Which existing tools can we use?
- how to refer to global func? `@ref{::name}' ?
- More user options
User options for
- size of toc, prot
- prot font
- columns in contents
- make @refs applicable only for file it apears in
- How to give file type on command line?
- Find refrences in const int x = 10; int a[x];
- Better guess of toc width? (pri 3)
- full expressin parsing (+ - etc)?
- math mode - changes I made in tth.
- find best flex & yacc flags
- try to improve flex speed
- can we have an image for up button, not via a hack?
- how do one checks in javascript if a file exists?
- should we treat `d4cab src doc' as `d4cab src doc .'?
- tth ask
- report error not to stdout?