Re: [Doxygen-users] How do I generate a single HTML file from just a marked-up comment?
Brought to you by:
dimitri
Menu
▾
▴
Re: [Doxygen-users] How do I generate a single HTML file from just a marked-up comment?
|
From: Robert H. <he...@de...> - 2019-11-04 16:13:56
|
At Mon, 4 Nov 2019 15:16:15 +0000 "Kerry, Richard" <ric...@at...> wrote: > > Content-Language: en-US > > > > > 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. > Set SEARCHENGINE and SERVER_BASED_SEARCH to NO as well. > 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. You are not going to get Doxygen to create one .html file and nothing else. Doxygen will drop its additional "overhead" files into the output html directory, even if your .html file does not reference them. It will include an index.html (even if it is basically empty), and some other .html files autogenerated. That said, it should be possible to create a .html file you can copy out of Doxygen's output directory to your own web pages. Read the commentary in your [generated] Doxyfile under HTML_HEADER and HTML_FOOTER and HTML_STYLESHEET *carefully* -- use "doxygen -w html new_header.html new_footer.html new_stylesheet.css" and then edit each of new_header.html, new_footer.html, and new_stylesheet.css to suit your web pages and specify these three files in your Doxyfile. If your HTML_HEADER, HTML_FOOTER, and HTML_STYLESHEET files are crafted properly, you should end up with a single .html file you can copy away from Doxygen's output. Doxygen will still drop some other random files in that directory that you will just ignore. > > 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 > ric...@at...<mailto:ric...@at...> > > [cid:image002.png@01D5930E.DB6E45C0] > > [Email-signature-banner_IBC-2019] > > Content-Description: image001.png > > > This message contains data in an unrecognized format, image/png, > which is being decoded and written to the file named "/home/heller/Mail/Attachments/352-image001.png". > If you do not want this data, you probably should delete that file. > Wrote file /home/heller/Mail/Attachments/352-image001.png > Content-Description: image002.png > > > This message contains data in an unrecognized format, image/png, > which is being decoded and written to the file named "/home/heller/Mail/Attachments/327-image002.png". > If you do not want this data, you probably should delete that file. > Wrote file /home/heller/Mail/Attachments/327-image002.png > Content-Description: image004.jpg > > > This message contains data in an unrecognized format, image/jpeg, > which is being decoded and written to the file named "/home/heller/Mail/Attachments/25-image004.jpg". > If you do not want this data, you probably should delete that file. > Wrote file /home/heller/Mail/Attachments/25-image004.jpg > MIME-Version: 1.0 > > > MIME-Version: 1.0 > > _______________________________________________ > Doxygen-users mailing list > Dox...@li... > https://lists.sourceforge.net/lists/listinfo/doxygen-users > > -- Robert Heller -- 978-544-6933 Deepwoods Software -- Custom Software Services http://www.deepsoft.com/ -- Linux Administration Services he...@de... -- Webhosting Services |
