I have a very large marked up comment which I would like to process using 
Doxygen to generate just one straightforward html file, and I don't seem to be 
getting any useful output.
I don't need a  full Doxygen mini web-site, just one page representing a 
straightforward html conversion of the comment with its markup.  It will be 
incorporated into an existing html structure, so doesn't need Doxygen's 
auto-generated navigation or search systems.
I am happy to do some editing on the comment as I am sure that will be 
necessary, but I don't want to hand-translate it all to html.  Everything I 
want is present, together with a load that I don't, and I will remove that in 
due course.

I think one significant issue is that because there is no source code at all, 
only a comment, the result has no meaningful content in the output.  I can't 
see any parameters that obviously relate to this issue.

I've set DISABLE_INDEX to YES, and SEARCHINDEX to NO but there are still some 
.js files being generated.  And although I'm pointing HTML_HEADER/FOOTER at my 
own header and footer files I'm still getting a load of png files written 
corresponding to bits of visual framework that Doxygen's own instances use.

I suspect there are a handful of key features I need to deal with in order to 
get this to work, and I would appreciate any pointers of where to start looking.


A bit of background detail...

What I've got is actually a header comment for part of Qt [1], specifically the 
Regular Expression module.
My application will make Qt regular expression format accessible to the user, 
and I want some documentation for the syntax.  At the top of Qt's 
implementation file is a very long comment (over 600 lines), a lot of which is 
a detailed explanation of the syntax, so I want to use most of that.  It 
already has loads of mark-up, which is interpreted by Qt's documentation 
generator and turned into html.  Given that Qt's auto-documentation syntax is a 
precursor to Doxygen I am assuming that they are similar enough that Doxygen 
can process what I've got.

I am assuming that Doxygen can do this in isolation, without any source code 
included, as it is obviously capable of doing this kind of transformation as 
part of the complex html that it generates by default, and it looks like the 
Doxygen web-site's documentation pages are generated by Doxygen but show no 
source code.  I am looking for more pointers on how to turn off areas that are 
still being generated by doxygen, and the key to why it isn't generating 
anything from the main comment.

Regards,
Richard.

[1] actually Qt3.  Yes, I know, "it's historical".


Richard Kerry
BNCS Engineer, Global Media Practice

M: +44 (0)7812 325518
2nd Floor, MidCity Place, 71 High Holborn, London, WC1V 6EA
richard.ke...@atos.net<mailto:richard.ke...@atos.net>

[cid:image002.png@01D5930E.DB6E45C0]

[Email-signature-banner_IBC-2019]

_______________________________________________
Doxygen-users mailing list
Doxygen-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users

Reply via email to