> Subject: Re: [Doxygen-users] How do I generate a single HTML file from just
> a marked-up comment?

 [RK>] Thanks Robert,
 
> > 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 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.

 [RK>] I've already done that. Whoops, when I said SEARCHINDEX I meant 
SEARCHENGINE.

> > 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.
> >
> 
> 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.
[RK>] Ok, I can live with that, just as long as there is an html file that I 
can copy out, or reference in-place.
[RK>] Though actually what I'm now getting is not what you describe.  I am 
getting an index.html file and no other .html files.
[RK>] so I must be missing something significant to persuade the system to 
generate some output form my comment.

> 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.

[RK>] Ok.
[RK>] I already have HTML_HEADER, HTML_FOOTER, and HTML_STYLESHEET set, and 
they are pointing at my existing ones.

[RK>] What is significant that I am missing at the moment is *anything at all* 
from the marked-up comment.
[RK>] I can deal with sub-optimal styling or screen furniture in due course.  
The ones I have now are fine, and the default doxygen ones also worked when I 
used them.  The problem is the content, or lack thereof.

Regards,
Richard.



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

Reply via email to