doxygen-users — List for users of doxygen

[Doxygen-users] Feature query

[Leo C. <lca...@bi...>]

Hi doxygen users,

Does any know if doxygen supports the following new C++ language features:
  a.. concepts 
  b.. spaceship operator
If yes, which version of doxygen provides the support?

Kind regards,
Leo

Re: [Doxygen-users] Paragraph spacing in PDF output

[DonM <dm4...@in...>]

Turns out, I think this is a bug in how doxygen handles horizontal rules for PDF.

I noticed that the first couple of paragraphs in my document had spaces between them, but then I used a horizontal rule and everything after that was jammed together.

Investigating further, the default doxygen.sty file includes
     \newcommand{\DoxyHorRuler}{%
       \setlength{\parskip}{0ex plus 0ex minus 0ex}%
       \hrule%
     }

And apparently that affects all paragraphs after the horizontal rule. I don' think it should do that -- maybe that's a doxygen bug?

Anyway, if I remove the horizontal rule, I get spaces between all my paragraphs. And then if I change the parskip settings in a custom header.tex, those changes get used in the document. For now, my workaround is to live without the horizontal rule.




On 12/16/2019 11:43 AM, Leonardo Pereira Santos wrote:
> DonM,
>
> I believe this is more of a LaTeX question, as you said that you can see the tex output being updated from your header. If I were in your shoes I would try LaTeX-specific resources, like TeX Exchange. That's where I usually get my questions answered.
>
> Have you tried to use the parskip package?
>
> \documentclass[parskip=full]{scrartcl}
>
>  From here:
>
> https://tex.stackexchange.com/questions/49188/how-to-insert-vertical-space-between-paragraphs
>
> Cheers!
>
> -----Original Message-----
> From: DonM <dm4...@in...>
> Sent: December 16, 2019 1:18 PM
> To: dox...@li...
> Subject: [Doxygen-users] Paragraph spacing in PDF output
>
>
> [External Email]: This email arrived from an external source - Please exercise caution when opening any attachments or clicking on links.
>
> When I produce PDF output from doxygen (v1.8.16), there is no additional spacing between paragraphs. That is, the space between paragraphs is the same as the space between lines in a paragraph. Is this normal?
>
> The default header.tex file specifies
>       \newcommand{\doxynormalparskip}{\setlength{\parskip}{3ex plus 2ex minus 2ex}}
>
> which looks like it would produce a pretty normal 12pt space between paragraphs. I tried a custom header where I changed that "3ex" to "6ex". This change was propagated to the produced refman.tex file, but there was no visible change to the PDF output, so I don't think that was the right thing to do.
>
> Any suggestions for how to change this? Thanks, DonM
>
>

[Doxygen-users] Paragraph spacing in PDF output

[DonM <dm4...@in...>]

When I produce PDF output from doxygen (v1.8.16), there is no additional spacing between paragraphs. That is, the space between paragraphs is the same as the space between lines in a paragraph. Is this normal?

The default header.tex file specifies
     \newcommand{\doxynormalparskip}{\setlength{\parskip}{3ex plus 2ex minus 2ex}}

which looks like it would produce a pretty normal 12pt space between paragraphs. I tried a custom header where I changed that "3ex" to "6ex". This change was propagated to the produced refman.tex file, but there was no visible change to the PDF output, so I don't think that was the right thing to do.

Any suggestions for how to change this? Thanks,
DonM

[Doxygen-users] How to control the width of a heading

[Andreas F. <and...@ge...>]

Hello,

We happily use doxygen in the CGAL project.

I am wondering if I can control the width reserved to a page header such as

CGAL::Triangulation_data_structure_2< Vb, Fb > Class Template Reference

on the page

https://doc.cgal.org/latest/TDS_2/classCGAL_1_1Triangulation__data__structure__2.html

It seems to be at 50% where doxygen puts the CR,  which makes it ugly.

Do I have to do something in a .css file, or is it configurable on a 
higher level?

Thanks,

Andreas

-- 
Andreas Fabri, PhD
Chief Officer, GeometryFactory
Editor, The CGAL Project

phone: +33.492.954.912    skype: andreas.fabri

Re: [Doxygen-users] Hyperlink to Word document from doxygen html (sidharth guria)

[Ken K. <kjk...@ya...>]

 Sidharth,
Why not save the word document as an HTML document and then you could reference the html document from doxygen.



----------------------------------------------------------------------

Message: 1
Date: Wed, 4 Dec 2019 14:29:33 +0000 (UTC)
From: sidharth guria <sid...@ya...>
To: "dox...@li..."
    <dox...@li...>,  Leonardo Pereira Santos
    <Leo...@on...>
Subject: Re: [Doxygen-users] Hyperlink to Word document from doxygen
    html
Message-ID: <191...@ma...>
Content-Type: text/plain; charset="utf-8"

Thanks a lot for your suggestion Leonardo!  On Thursday, 28 November, 2019, 07:54:48 pm GMT+1, Leonardo Pereira Santos <leo...@on...> wrote:  
 
 I don't think you can do that. If you're browsing your HTML documentation with Chrome and click on a link, *Chrome* will do what it thinks it's correct for the file type. If it's a Word file, Chrome will download it. The user would download the file and open it in Word. Unless the user has some sort of Word plugin in Chrome, but Doxygen doesn't know that.

Could you just create a PDF file from your Word file and link it the same way you're doing with the Word file? This way you will take advantage that most browsers can open PDF files.

Leonardo

-----Original Message-----
From: AwordSid via Doxygen-users <dox...@li...> 
Sent: November 28, 2019 11:29 AM
To: dox...@li...
Subject: [Doxygen-users] Hyperlink to Word document from doxygen html


[External Email]: This email arrived from an external source - Please exercise caution when opening any attachments or clicking on links.

Hello, I have a requirement document in Word format. I have been trying to

insert a hyperlink in doxygen html, that would open the requirement linked

to that part of code. Which means, it opens the local Word document and

jumps to the requirement ID.



I have already tried using this:

link name <your_doc.docx>? 

But from Chrome, this always opens a 'Download file' popup.



How can this be done? 







--

Sent from: https://urldefense.proofpoint.com/v2/url?u=http-3A__doxygen.10944.n7.nabble.com_Doxygen-2DUsers-2Df3.html&d=DwICAg&c=MHZppzMdXMt3JYjCV71UsQ&r=k8KpFgIlnqWJ_UCMIorh7Kaa71fn5J46EO16Eh-Dgx5RVhccwhWRNbrzEpx0RhhR&m=ohcD13F8UC9dvgkAwhwW1IrENt-XH6R0rrtrL8sY33w&s=BlNQDiKIU1GAmHx4mC7O8nY80Cg5N1kjRT477RhUYtU&e= 





_______________________________________________

Doxygen-users mailing list

Dox...@li...

https://urldefense.proofpoint.com/v2/url?u=https-3A__lists.sourceforge.net_lists_listinfo_doxygen-2Dusers&d=DwICAg&c=MHZppzMdXMt3JYjCV71UsQ&r=k8KpFgIlnqWJ_UCMIorh7Kaa71fn5J46EO16Eh-Dgx5RVhccwhWRNbrzEpx0RhhR&m=ohcD13F8UC9dvgkAwhwW1IrENt-XH6R0rrtrL8sY33w&s=Dvs8xlflknwe8D8LFbnucVtmJG4m1vI7z5Hc1J4AYE4&e= 



_______________________________________________
Doxygen-users mailing list
Dox...@li...
https://lists.sourceforge.net/lists/listinfo/doxygen-users
  
-------------- next part --------------
An HTML attachment was scrubbed...

------------------------------



------------------------------

Subject: Digest Footer

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


------------------------------

End of Doxygen-users Digest, Vol 161, Issue 1
*********************************************
  

Re: [Doxygen-users] Hyperlink to Word document from doxygen html

[sidharth g. <sid...@ya...>]

Thanks a lot for your suggestion Leonardo!   On Thursday, 28 November, 2019, 07:54:48 pm GMT+1, Leonardo Pereira Santos <leo...@on...> wrote:  
 
 I don't think you can do that. If you're browsing your HTML documentation with Chrome and click on a link, *Chrome* will do what it thinks it's correct for the file type. If it's a Word file, Chrome will download it. The user would download the file and open it in Word. Unless the user has some sort of Word plugin in Chrome, but Doxygen doesn't know that.

Could you just create a PDF file from your Word file and link it the same way you're doing with the Word file? This way you will take advantage that most browsers can open PDF files.

Leonardo

-----Original Message-----
From: AwordSid via Doxygen-users <dox...@li...> 
Sent: November 28, 2019 11:29 AM
To: dox...@li...
Subject: [Doxygen-users] Hyperlink to Word document from doxygen html


[External Email]: This email arrived from an external source - Please exercise caution when opening any attachments or clicking on links.

Hello, I have a requirement document in Word format. I have been trying to

insert a hyperlink in doxygen html, that would open the requirement linked

to that part of code. Which means, it opens the local Word document and

jumps to the requirement ID.



I have already tried using this:

link name <your_doc.docx>  

But from Chrome, this always opens a 'Download file' popup.



How can this be done? 







--

Sent from: https://urldefense.proofpoint.com/v2/url?u=http-3A__doxygen.10944.n7.nabble.com_Doxygen-2DUsers-2Df3.html&d=DwICAg&c=MHZppzMdXMt3JYjCV71UsQ&r=k8KpFgIlnqWJ_UCMIorh7Kaa71fn5J46EO16Eh-Dgx5RVhccwhWRNbrzEpx0RhhR&m=ohcD13F8UC9dvgkAwhwW1IrENt-XH6R0rrtrL8sY33w&s=BlNQDiKIU1GAmHx4mC7O8nY80Cg5N1kjRT477RhUYtU&e= 





_______________________________________________

Doxygen-users mailing list

Dox...@li...

https://urldefense.proofpoint.com/v2/url?u=https-3A__lists.sourceforge.net_lists_listinfo_doxygen-2Dusers&d=DwICAg&c=MHZppzMdXMt3JYjCV71UsQ&r=k8KpFgIlnqWJ_UCMIorh7Kaa71fn5J46EO16Eh-Dgx5RVhccwhWRNbrzEpx0RhhR&m=ohcD13F8UC9dvgkAwhwW1IrENt-XH6R0rrtrL8sY33w&s=Dvs8xlflknwe8D8LFbnucVtmJG4m1vI7z5Hc1J4AYE4&e= 



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

Re: [Doxygen-users] Hyperlink to Word document from doxygen html

[Leonardo P. S. <Leo...@on...>]

I don't think you can do that. If you're browsing your HTML documentation with Chrome and click on a link, *Chrome* will do what it thinks it's correct for the file type. If it's a Word file, Chrome will download it. The user would download the file and open it in Word. Unless the user has some sort of Word plugin in Chrome, but Doxygen doesn't know that.

Could you just create a PDF file from your Word file and link it the same way you're doing with the Word file? This way you will take advantage that most browsers can open PDF files.

Leonardo

-----Original Message-----
From: AwordSid via Doxygen-users <dox...@li...> 
Sent: November 28, 2019 11:29 AM
To: dox...@li...
Subject: [Doxygen-users] Hyperlink to Word document from doxygen html


[External Email]: This email arrived from an external source - Please exercise caution when opening any attachments or clicking on links.

Hello, I have a requirement document in Word format. I have been trying to

insert a hyperlink in doxygen html, that would open the requirement linked

to that part of code. Which means, it opens the local Word document and

jumps to the requirement ID.



I have already tried using this:

link name <your_doc.docx>   

But from Chrome, this always opens a 'Download file' popup.



How can this be done? 







--

Sent from: https://urldefense.proofpoint.com/v2/url?u=http-3A__doxygen.10944.n7.nabble.com_Doxygen-2DUsers-2Df3.html&d=DwICAg&c=MHZppzMdXMt3JYjCV71UsQ&r=k8KpFgIlnqWJ_UCMIorh7Kaa71fn5J46EO16Eh-Dgx5RVhccwhWRNbrzEpx0RhhR&m=ohcD13F8UC9dvgkAwhwW1IrENt-XH6R0rrtrL8sY33w&s=BlNQDiKIU1GAmHx4mC7O8nY80Cg5N1kjRT477RhUYtU&e= 





_______________________________________________

Doxygen-users mailing list

Dox...@li...

https://urldefense.proofpoint.com/v2/url?u=https-3A__lists.sourceforge.net_lists_listinfo_doxygen-2Dusers&d=DwICAg&c=MHZppzMdXMt3JYjCV71UsQ&r=k8KpFgIlnqWJ_UCMIorh7Kaa71fn5J46EO16Eh-Dgx5RVhccwhWRNbrzEpx0RhhR&m=ohcD13F8UC9dvgkAwhwW1IrENt-XH6R0rrtrL8sY33w&s=Dvs8xlflknwe8D8LFbnucVtmJG4m1vI7z5Hc1J4AYE4&e= 

[Doxygen-users] Hyperlink to Word document from doxygen html

[AwordSid <sid...@ya...>]

Hello, I have a requirement document in Word format. I have been trying to
insert a hyperlink in doxygen html, that would open the requirement linked
to that part of code. Which means, it opens the local Word document and
jumps to the requirement ID.

I have already tried using this:
link name <your_doc.docx>   
But from Chrome, this always opens a 'Download file' popup.

How can this be done? 



--
Sent from: http://doxygen.10944.n7.nabble.com/Doxygen-Users-f3.html

[Doxygen-users] Question about controlling the documentation of enumerations

[John S. <joh...@be...>]

Hi,

I’m using Doxygen to document a C++ library. Documentation of enumerations is not nearly as helpful as it might be, and I can’t find anything about controlling the output. I’ve made a small example to illustrate what I mean. The help puts an undocumented version of the enumeration at the top of the namespace page, individual elements of which link to the actual useful documentation, under Enumeration Type Documentation. In a real example, there may be many of these undocumented enumerations before the Help file gets around to the Enumeration Type Documentation section where the useful help documenting the use of each value can be found.

How can I suppress the Enumerations section of the following entirely, while leaving the  Enumeration Type Documentation section that actually documents the enumeration values?

An example page illustrating the problem:

MyNamespace Namespace Reference

My main namespace. More...

Enumerations
enum
MyExampleEnum<namespace_my_namespace.html#a84257abe6faa6a7ce3be15be5c603451> {
  UNKNOWN,
  MyExampleEnum::FirstValue<namespace_my_namespace.html#a84257abe6faa6a7ce3be15be5c603451a72fbccc72f1137a08c4b289d51a0a18c>,
  MyExampleEnum::SecondValue<namespace_my_namespace.html#a84257abe6faa6a7ce3be15be5c603451a9ba5d057430771223955c4723b366b36>,
  COUNT
}

An example enumeration with the useful values documented. More...<namespace_my_namespace.html#a84257abe6faa6a7ce3be15be5c603451>

Detailed Description

My main namespace.

Enumeration Type Documentation
◆ MyExampleEnum
enum MyNamespace::MyExampleEnum<namespace_my_namespace.html#a84257abe6faa6a7ce3be15be5c603451>
strong

An example enumeration with the useful values documented.
Enumerator
FirstValue

This is the useful documentation.
SecondValue

This is useful documentation of SecondValue.


I’ve attached the .h file, but I’m not sending the configuration file or the HTML output file due to space constraints.

Thanks,
John Schmitz


John Schmitz
Lead Software Engineer - Bethesda.net
1370 Piccard Drive | Rockville, MD  20850
[Description: cid:image001.gif@01C9A895.4CFB2250] Main: 301-948-2200  |    [Description: cid:image002.gif@01C9A895.4CFB2250]   Fax: 301-354-4447
[Description: cid:image004.gif@01C9A895.4CFB2250] Website: www.zenimax.com<http://www.zenimax.com/>

Re: [Doxygen-users] Attributes within Html elements (eg table, tr, td) break things

[Robert H. <he...@de...>]

At Tue, 5 Nov 2019 16:04:06 +0000 "Kerry, Richard" <ric...@at...> wrote:

> 
> Content-Language: en-US
> 
> 
> 
> As indicated by the docs, on the page "HTML Commands" if I include in my document what appear to be a raw Html element, eg <table>, <tr>, I get the same element appearing in the html output file.  This is fine.
> However, if I include any attributes, eg <table border="0">, I get nothing in the output apart from "&lt; table".  This is not what I want.
> Is it really the case that attributes from elements used in this way don't get carried over into the output ?  Or am I missing something ?
> 
> Oh, and in case it has any bearing, I'm actually doing these via Aliases, eg:
> ALIASES += table=<table border="0">
> ALIASES += row=<tr bgcolor=\"\#f0f0f0\">

Two things:

I am not sure how doxygen handles ALIASES, but the above looks "funky" to me 
on some level.

I don't know if doxygen understands that the alias is for a HTML element or 
just replacement text.  I expect the latter.  That is, it is not processing 
the alias as HTML, but instead treating it like "normal" text and 
automagically excaping it as needed, depending on the output format -- eg 
converting the "literal" '<' to "&lt;" in the HTML output.  You might not be 
able to use aliases for the HTML elements.

If you *don't* use the ALIASES but include the HTML directly, does it work?

> 
> I've tried a variety of options with or without escaping things using \, but it seems that any attempt to include attributes causes the whole element to break down.
> 
> Anyone know if I'm missing something?
> 
> Regards,
> Richard.
> 
> 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@01D593F1.EB427460]
> 
> [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/356-image001.png".
> If you do not want this data, you probably should delete that file.
> Wrote file /home/heller/Mail/Attachments/356-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/332-image002.png".
> If you do not want this data, you probably should delete that file.
> Wrote file /home/heller/Mail/Attachments/332-image002.png
> Content-Description: image005.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/10-image005.jpg".
> If you do not want this data, you probably should delete that file.
> Wrote file /home/heller/Mail/Attachments/10-image005.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
                                                                                     

[Doxygen-users] Attributes within Html elements (eg table, tr, td) break things

[Kerry, R. <ric...@at...>]

As indicated by the docs, on the page "HTML Commands" if I include in my document what appear to be a raw Html element, eg <table>, <tr>, I get the same element appearing in the html output file.  This is fine.
However, if I include any attributes, eg <table border="0">, I get nothing in the output apart from "&lt; table".  This is not what I want.
Is it really the case that attributes from elements used in this way don't get carried over into the output ?  Or am I missing something ?

Oh, and in case it has any bearing, I'm actually doing these via Aliases, eg:
ALIASES += table=<table border="0">
ALIASES += row=<tr bgcolor=\"\#f0f0f0\">

I've tried a variety of options with or without escaping things using \, but it seems that any attempt to include attributes causes the whole element to break down.

Anyone know if I'm missing something?

Regards,
Richard.

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@01D593F1.EB427460]

[Email-signature-banner_IBC-2019]

[Doxygen-users] PDF Generation overlapping objects issue

[jgreninger <jgr...@ho...>]

I'm generating a large document (~1000 pages) using Doxygen. Some of the
tables are half on a page, half off or they are overlapping other objects. 
I've tried inserting \FloatBarrier after each section, subsection,
subsubsection but still have the issue. Is there a way to fix it?



--
Sent from: http://doxygen.10944.n7.nabble.com/Doxygen-Users-f3.html

Re: [Doxygen-users] Is there such a thing as commenting-out doxygen markdown?

[Kerry, R. <ric...@at...>]

Yes, I thought it would be something like that.
Hence my query about whether the preprocessor acts before the lexical analyzer dumps the comments. 
I haven't really got the option of using /// as I am working with an existing document which has a comment of the form /*! Etc.
While I could edit the whole thing into that form I'm trying to avoid that as I am trying to keep the document as much as possible the same as the original.

R.

> > It doesn’t work.
> >
> > Warning: explicit link request to ‘if’ could not be resolved.
> > Warning: explicit link request to ‘endif’ could not be resolved.
> >
> > Note – I am trying to “comment out” individual lines within a doxygen
> > comment block, not comment out the whole comment.
> >
> > I wonder if #if works in a comment?  I’ve never actually tried it, I’m
> > just wondering out loud whether the pre-processor acts before or after
> > the lexical analyser strips comments.
> >
> You can't do
> 
> /**
> 
> #if
> 
> */
> 
> as comments are removed before preprocessing
> 
> 
> You should be able to do
> 
> 
> ///
> 
> ///
> 
> ///
> 
> #if 0
> 
> ///
> 
> ///
> 
> ///
> 
> #endif
> 
> ///
> 
> ///
> 
> ///
> 
> 
> to remove specific lines of comment.
> 
> --
> Richard Damon

Re: [Doxygen-users] Is there such a thing as commenting-out doxygen markdown?

[Richard D. <Ri...@Da...>]

On 11/5/19 6:19 AM, Kerry, Richard wrote:
>
> It doesn’t work.
>
> Warning: explicit link request to ‘if’ could not be resolved.
>
> Warning: explicit link request to ‘endif’ could not be resolved.
>
>  
>
> Note – I am trying to “comment out” individual lines within a doxygen
> comment block, not comment out the whole comment.
>
>  
>
> Regards
>
> Richard.
>
>  
>
>  
>
> Ok, that’s a thought, I’ll give that a try.
>
>  
>
> I wonder if #if works in a comment?  I’ve never actually tried it, I’m
> just wondering out loud whether the pre-processor acts before or after
> the lexical analyser strips comments.
>
>  
>
You can't do

/**

#if

*/

as comments are removed before preprocessing


You should be able to do


///

///

///

#if 0

///

///

///

#endif

///

///

///


to remove specific lines of comment.

-- 
Richard Damon

Re: [Doxygen-users] Is there such a thing as commenting-out doxygen markdown?

[Kerry, R. <ric...@at...>]

It doesn’t work.
Warning: explicit link request to ‘if’ could not be resolved.
Warning: explicit link request to ‘endif’ could not be resolved.

Note – I am trying to “comment out” individual lines within a doxygen comment block, not comment out the whole comment.

Regards
Richard.


Ok, that’s a thought, I’ll give that a try.

I wonder if #if works in a comment?  I’ve never actually tried it, I’m just wondering out loud whether the pre-processor acts before or after the lexical analyser strips comments.

Re: [Doxygen-users] Is there such a thing as commenting-out doxygen markdown?

[Kerry, R. <ric...@at...>]

Sorry, I've just worked out why that seemed to have worked.
It's actually turned them into Markdown, level one headers.

Richard.

> Actually, I've just tried something completely off the wall, which is to start
> the line with '#', and that seems to have worked!
> Ie the same comment char that doxygen's config file uses.
> 
> 
> Richard Kerry

Re: [Doxygen-users] Is there such a thing as commenting-out doxygen markdown?

[Kerry, R. <ric...@at...>]

Actually, I've just tried something completely off the wall, which is to start the line with '#', and that seems to have worked!
Ie the same comment char that doxygen's config file uses.


Richard Kerry
BNCS Engineer, Global Media Practice

M: +44 (0)7812 325518
2nd Floor, MidCity Place, 71 High Holborn, London, WC1V 6EA
ric...@at...
 


> 
> Yes, Ok, that looks like it should work.
> I looks a bit clumsy, but looks like it should work.  I'll give that a try.
> 
> Regards,
> Richard.
> 
> > >
> > > A Doxygen comment is pretty well explained in the docs, but is there
> > > some
> > syntax to comment-out a line of mark-up in a Doxygen comment block ?
> > >
> > > In the course of trying to get my documentation working (see
> > > elsewhere)
> > I'd like to try removing some of the markup.  But I don't want to just
> > delete it, or even to cut it and copy it elsewhere.  If it were source
> > code I'd just stick line comment characters at the start of the line.
> > Is there an equivalent I can use within a comment block to get doxygen
> > to ignore a line, without actually removing it?
> >
> > Probably closing the comment and then reopening it *without* the
> > Doxygen
> > flagging:
> >
> > /** This is for Doxygen
> >  * more for Doxygen
> >  */
> > /* something else (Doxygen will ignore this, even if there are Doxygen
> >  * directives here)
> >  */
> > /** More for Doxygen
> >  * still more for Doxygen
> >  */
> >
> > (similar WRT /// or //! or /*! commenting)
> >

Re: [Doxygen-users] Is there such a thing as commenting-out doxygen markdown?

[Kerry, R. <ric...@at...>]

Yes, Ok, that looks like it should work.
I looks a bit clumsy, but looks like it should work.  I'll give that a try.

Regards,
Richard.

> >
> > A Doxygen comment is pretty well explained in the docs, but is there some
> syntax to comment-out a line of mark-up in a Doxygen comment block ?
> >
> > In the course of trying to get my documentation working (see elsewhere)
> I'd like to try removing some of the markup.  But I don't want to just delete it,
> or even to cut it and copy it elsewhere.  If it were source code I'd just stick
> line comment characters at the start of the line.  Is there an equivalent I can
> use within a comment block to get doxygen to ignore a line, without actually
> removing it?
> 
> Probably closing the comment and then reopening it *without* the Doxygen
> flagging:
> 
> /** This is for Doxygen
>  * more for Doxygen
>  */
> /* something else (Doxygen will ignore this, even if there are Doxygen
>  * directives here)
>  */
> /** More for Doxygen
>  * still more for Doxygen
>  */
> 
> (similar WRT /// or //! or /*! commenting)
> 

Re: [Doxygen-users] Is there such a thing as commenting-out doxygen markdown?

[Kerry, R. <ric...@at...>]

Ok, that’s a thought, I’ll give that a try.

I wonder if #if works in a comment?  I’ve never actually tried it, I’m just wondering out loud whether the pre-processor acts before or after the lexical analyser strips comments.

Regards,
Richard.


If it is in a C/C++ code file, I just use an #if 0/#endif to comment the comment out.

A Doxygen comment is pretty well explained in the docs, but is there some syntax to comment-out a line of mark-up in a Doxygen comment block ?

In the course of trying to get my documentation working (see elsewhere) I’d like to try removing some of the markup.  But I don’t want to just delete it, or even to cut it and copy it elsewhere.  If it were source code I’d just stick line comment characters at the start of the line.  Is there an equivalent I can use within a comment block to get doxygen to ignore a line, without actually removing it?

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

[Kerry, R. <ric...@at...>]

Yes, \page is the answer to this.
And there is an index.html created as well as the file that I want.

> > > Doxygen to generate just one straightforward html file, and I don't
> > > seem to be getting any useful output.
> > >
> > > 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>] 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.
> 
> index.html is created from a "\mainpage <title>" directive. If there is no
> \mainpage, then doxygen does some "default" thing. To generate some
> other page, then use "\page name <title>". This will create name.html.

[RK>] Ok, this is now fine.
[RK>] The \page directive is the key to getting arbitrary text in.
[RK>] And as you say, index.html is being created with some basic navigation stuff.

> > > 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. 
> > > Doxygen will still drop some other random files in that directory
> > > that you will just ignore.

[RK>] And there is, as suggested, an index.html, which just links to all the other content.  So on using \page I get a specific html file generated, which I can easily extract, or link to.
 
> Try putting in a \page name Something in front of the markup. If the mark up
> is not part of some C/C++ thing (class, typedef, etc.) and not on the
> \mainpage [index.html] or a \page name [name.html] you might not get
> much or else with a lot of extrainious screen furniture. (There are also
> groups, but that will create a "Module", which you might not want.)  Using
> \page gets you something outside of a code oriented documentation (eg
> stuff related to code elements like classes or functions, etc.).

[RK>] Yes, \page was the key to getting this sorted.
[RK>] Although I think I have seen in the documentation a list that includes \class, \page, \file and others, I can't now find it.  Although I did find \page late yesterday afternoon it wasn't easy to find.  
[RK>] Regards,
[RK>] Richard.

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

[Robert H. <he...@de...>]

At Mon, 4 Nov 2019 16:14:19 +0000 "Kerry, Richard" <ric...@at...> wrote:

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

index.html is created from a "\mainpage <title>" directive. If there is no
\mainpage, then doxygen does some "default" thing. To generate some other
page, then use "\page name <title>". This will create name.html.

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

Try putting in a \page name Something in front of the markup. If the mark up
is not part of some C/C++ thing (class, typedef, etc.) and not on the
\mainpage [index.html] or a \page name [name.html] you might not get much or
else with a lot of extrainious screen furniture. (There are also groups, but
that will create a "Module", which you might not want.)  Using \page gets you 
something outside of a code oriented documentation (eg stuff related to code 
elements like classes or functions, etc.).

> 
> Regards,
> Richard.
> 
> 
> 
> _______________________________________________
> 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
                                     

Re: [Doxygen-users] Is there such a thing as commenting-out doxygen markdown?

[Robert H. <he...@de...>]

At Mon, 4 Nov 2019 16:38:05 +0000 "Kerry, Richard" <ric...@at...> wrote:

> 
> Content-Language: en-US
> 
> 
> 
> 
> A Doxygen comment is pretty well explained in the docs, but is there some syntax to comment-out a line of mark-up in a Doxygen comment block ?
> 
> In the course of trying to get my documentation working (see elsewhere) I'd like to try removing some of the markup.  But I don't want to just delete it, or even to cut it and copy it elsewhere.  If it were source code I'd just stick line comment characters at the start of the line.  Is there an equivalent I can use within a comment block to get doxygen to ignore a line, without actually removing it?

Probably closing the comment and then reopening it *without* the Doxygen 
flagging:

/** This is for Doxygen
 * more for Doxygen
 */
/* something else (Doxygen will ignore this, even if there are Doxygen 
 * directives here) 
 */
/** More for Doxygen
 * still more for Doxygen
 */
 
(similar WRT /// or //! or /*! commenting)

> 
> 
> Regards,
> Richard.
> 
> 
> 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@01D5932E.3A7D8160]
> 
> [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/355-image001.png".
> If you do not want this data, you probably should delete that file.
> Wrote file /home/heller/Mail/Attachments/355-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/330-image002.png".
> If you do not want this data, you probably should delete that file.
> Wrote file /home/heller/Mail/Attachments/330-image002.png
> Content-Description: image003.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/48-image003.jpg".
> If you do not want this data, you probably should delete that file.
> Wrote file /home/heller/Mail/Attachments/48-image003.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
                                                                                                                               

Re: [Doxygen-users] Is there such a thing as commenting-out doxygen markdown?

[Richard D. <Ri...@Da...>]

If it is in a C/C++ code file, I just use an #if 0/#endif to comment the comment out.

> On Nov 4, 2019, at 11:38 AM, Kerry, Richard <ric...@at...> wrote:
> 
> 
>  
> A Doxygen comment is pretty well explained in the docs, but is there some syntax to comment-out a line of mark-up in a Doxygen comment block ?
>  
> In the course of trying to get my documentation working (see elsewhere) I’d like to try removing some of the markup.  But I don’t want to just delete it, or even to cut it and copy it elsewhere.  If it were source code I’d just stick line comment characters at the start of the line.  Is there an equivalent I can use within a comment block to get doxygen to ignore a line, without actually removing it?
>  
>  
> Regards,
> Richard.
>  
> <image001.png>
> Richard Kerry
> BNCS Engineer, Global Media Practice
>  
> M: +44 (0)7812 325518
> 2nd Floor, MidCity Place, 71 High Holborn, London, WC1V 6EA
> ric...@at...
>  
> <image002.png>
>  
> <image003.jpg>
>  
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users

[Doxygen-users] Is there such a thing as commenting-out doxygen markdown?

[Kerry, R. <ric...@at...>]

A Doxygen comment is pretty well explained in the docs, but is there some syntax to comment-out a line of mark-up in a Doxygen comment block ?

In the course of trying to get my documentation working (see elsewhere) I'd like to try removing some of the markup.  But I don't want to just delete it, or even to cut it and copy it elsewhere.  If it were source code I'd just stick line comment characters at the start of the line.  Is there an equivalent I can use within a comment block to get doxygen to ignore a line, without actually removing it?


Regards,
Richard.


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@01D5932E.3A7D8160]

[Email-signature-banner_IBC-2019]

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

[Kerry, R. <ric...@at...>]

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