doxygen-users Mailing List for Doxygen (Page 62)
Brought to you by:
dimitri
You can subscribe to this list here.
2001 |
Jan
|
Feb
|
Mar
|
Apr
(1) |
May
(118) |
Jun
(150) |
Jul
(115) |
Aug
(75) |
Sep
(92) |
Oct
(102) |
Nov
(139) |
Dec
(87) |
---|---|---|---|---|---|---|---|---|---|---|---|---|
2002 |
Jan
(131) |
Feb
(60) |
Mar
(114) |
Apr
(83) |
May
(125) |
Jun
(82) |
Jul
(95) |
Aug
(98) |
Sep
(109) |
Oct
(97) |
Nov
(72) |
Dec
(70) |
2003 |
Jan
(117) |
Feb
(122) |
Mar
(187) |
Apr
(114) |
May
(154) |
Jun
(131) |
Jul
(130) |
Aug
(98) |
Sep
(121) |
Oct
(107) |
Nov
(80) |
Dec
(54) |
2004 |
Jan
(78) |
Feb
(71) |
Mar
(118) |
Apr
(56) |
May
(56) |
Jun
(64) |
Jul
(164) |
Aug
(104) |
Sep
(101) |
Oct
(69) |
Nov
(107) |
Dec
(98) |
2005 |
Jan
(75) |
Feb
(77) |
Mar
(107) |
Apr
(114) |
May
(142) |
Jun
(106) |
Jul
(79) |
Aug
(108) |
Sep
(115) |
Oct
(140) |
Nov
(128) |
Dec
(63) |
2006 |
Jan
(86) |
Feb
(71) |
Mar
(125) |
Apr
(55) |
May
(48) |
Jun
(143) |
Jul
(99) |
Aug
(91) |
Sep
(93) |
Oct
(82) |
Nov
(46) |
Dec
(45) |
2007 |
Jan
(69) |
Feb
(97) |
Mar
(125) |
Apr
(112) |
May
(65) |
Jun
(80) |
Jul
(82) |
Aug
(84) |
Sep
(56) |
Oct
(74) |
Nov
(63) |
Dec
(74) |
2008 |
Jan
(161) |
Feb
(115) |
Mar
(58) |
Apr
(73) |
May
(58) |
Jun
(79) |
Jul
(57) |
Aug
(115) |
Sep
(79) |
Oct
(62) |
Nov
(93) |
Dec
(37) |
2009 |
Jan
(69) |
Feb
(115) |
Mar
(77) |
Apr
(85) |
May
(124) |
Jun
(58) |
Jul
(44) |
Aug
(85) |
Sep
(90) |
Oct
(80) |
Nov
(87) |
Dec
(48) |
2010 |
Jan
(52) |
Feb
(71) |
Mar
(54) |
Apr
(37) |
May
(66) |
Jun
(86) |
Jul
(84) |
Aug
(68) |
Sep
(94) |
Oct
(66) |
Nov
(36) |
Dec
(53) |
2011 |
Jan
(59) |
Feb
(77) |
Mar
(59) |
Apr
(67) |
May
(76) |
Jun
(54) |
Jul
(95) |
Aug
(92) |
Sep
(84) |
Oct
(72) |
Nov
(46) |
Dec
(60) |
2012 |
Jan
(43) |
Feb
(77) |
Mar
(88) |
Apr
(121) |
May
(81) |
Jun
(69) |
Jul
(97) |
Aug
(64) |
Sep
(55) |
Oct
(55) |
Nov
(38) |
Dec
(60) |
2013 |
Jan
(85) |
Feb
(70) |
Mar
(81) |
Apr
(83) |
May
(51) |
Jun
(65) |
Jul
(71) |
Aug
(39) |
Sep
(47) |
Oct
(32) |
Nov
(43) |
Dec
(28) |
2014 |
Jan
(64) |
Feb
(22) |
Mar
(54) |
Apr
(20) |
May
(59) |
Jun
(20) |
Jul
(50) |
Aug
(17) |
Sep
(37) |
Oct
(56) |
Nov
(40) |
Dec
(24) |
2015 |
Jan
(51) |
Feb
(29) |
Mar
(57) |
Apr
(31) |
May
(23) |
Jun
(50) |
Jul
(30) |
Aug
(66) |
Sep
(59) |
Oct
(21) |
Nov
(29) |
Dec
(12) |
2016 |
Jan
(33) |
Feb
(30) |
Mar
(19) |
Apr
(23) |
May
(16) |
Jun
(31) |
Jul
(17) |
Aug
(19) |
Sep
(21) |
Oct
(20) |
Nov
(15) |
Dec
(6) |
2017 |
Jan
(16) |
Feb
(13) |
Mar
(16) |
Apr
(23) |
May
(16) |
Jun
(5) |
Jul
(14) |
Aug
(13) |
Sep
(12) |
Oct
(11) |
Nov
(3) |
Dec
(6) |
2018 |
Jan
(4) |
Feb
(6) |
Mar
(5) |
Apr
(11) |
May
(26) |
Jun
(5) |
Jul
(10) |
Aug
(7) |
Sep
(3) |
Oct
|
Nov
(3) |
Dec
(7) |
2019 |
Jan
(17) |
Feb
(18) |
Mar
(5) |
Apr
(6) |
May
(3) |
Jun
|
Jul
(9) |
Aug
(19) |
Sep
(3) |
Oct
(1) |
Nov
(23) |
Dec
(5) |
2020 |
Jan
(7) |
Feb
(1) |
Mar
(7) |
Apr
(11) |
May
(8) |
Jun
(7) |
Jul
(10) |
Aug
(3) |
Sep
(4) |
Oct
(7) |
Nov
(6) |
Dec
|
2021 |
Jan
(3) |
Feb
|
Mar
(4) |
Apr
(4) |
May
|
Jun
|
Jul
(1) |
Aug
(3) |
Sep
|
Oct
|
Nov
(8) |
Dec
(3) |
2022 |
Jan
(2) |
Feb
|
Mar
(1) |
Apr
|
May
(3) |
Jun
(1) |
Jul
|
Aug
(3) |
Sep
(9) |
Oct
(2) |
Nov
|
Dec
(2) |
2023 |
Jan
(2) |
Feb
(5) |
Mar
(3) |
Apr
(7) |
May
(6) |
Jun
(2) |
Jul
(5) |
Aug
|
Sep
(4) |
Oct
(1) |
Nov
(5) |
Dec
(5) |
2024 |
Jan
|
Feb
|
Mar
|
Apr
|
May
(3) |
Jun
(4) |
Jul
|
Aug
(3) |
Sep
|
Oct
|
Nov
(1) |
Dec
|
From: marco r. <mre...@gm...> - 2014-04-17 09:24:50
|
2014-04-17 11:08 GMT+0200, marco restelli <mre...@gm...>: > Hi all, > I am using Doxygen (version 1.8.5) to document a fortran code and I > have a small problem with the automatic link generation. > > I define a type > > type :: c_stv > ... > end type c_stv > > and then, in the doxygen documentation, I type c_stv and I would > like to get a link to the type definition. What I see is that > sometimes the link is generated correctly, while sometimes it is > missing. I see now that probably the situation is simpler: assuming that c_stv is defined in the module mod_stv, I can get the link by using: * in the file mod_stv.f90 -> c_stv * in any other file -> mod_stv::c_stv I think this solves my problem; sorry for not realizing this before. Marco |
From: marco r. <mre...@gm...> - 2014-04-17 09:08:28
|
Hi all, I am using Doxygen (version 1.8.5) to document a fortran code and I have a small problem with the automatic link generation. I define a type type :: c_stv ... end type c_stv and then, in the doxygen documentation, I type c_stv and I would like to get a link to the type definition. What I see is that sometimes the link is generated correctly, while sometimes it is missing. The code is distributed in different files and directories, so I think the reason is that when processing some files the symbol c_stv is known to refer to a user defined type while when processing other files it is not. Is there a general rule to make sure that a symbol is treated correctly among files and directories, such as specifying the order in which these files should be processed by doxygen? If not, is there a way to manually specify the link when it is missing? Thank you, sincerely, Marco Restelli |
From: Albert <alb...@gm...> - 2014-04-16 17:27:10
|
doxygen sees the /*/ as a new start of a comment and at the end of the scanning process this will result in the warning as shown. In the git version we also get the message: warning: Reached end of file while still inside a (nested) comment. Nesting level 2 (probable line reference: 5, 5) replacing /*/ by / */ will solve the problem (signals in my opinion also better the intention of the comment line). Another possibility would be to use // as comment On Wed, Apr 16, 2014 at 5:02 PM, Arthur Schwarz <asc...@at...>wrote: > > > Doxygen v1.8.6 > > > Diagnostic Message: SlipWrite.cpp:10: warning: File ended in the middle of > a comment block! Perhaps a missing \endcode? > > > Removing the namespace slip { }; or replacing "/*/" with "*/" removes the > warning. Namespace seems to work in other contexts and I don't think that > "/*/" is a valid Doxygen command. Is this a bug? > > > > ================== code ================== > > namespace slip { > void SlipWrite::fitOutput(string& str) { > static const char xTable[256] = > { > /* sp ! " # $ % & ' ( ) * + - > , . /*/ > SPC, IGN, QUO, IGN, IGN, IGN, IGN, CHR, IGN, IGN, IGN, IGN, IGN, > IGN, IGN, 0, > }; > }; // void SlipWrite::fitOutput(string& str) > }; > > > ------------------------------------------------------------------------------ > Learn Graph Databases - Download FREE O'Reilly Book > "Graph Databases" is the definitive new guide to graph databases and their > applications. Written by three acclaimed leaders in the field, > this first edition is now available. Download your free book today! > http://p.sf.net/sfu/NeoTech > _______________________________________________ > Doxygen-users mailing list > Dox...@li... > https://lists.sourceforge.net/lists/listinfo/doxygen-users > |
From: Arthur S. <asc...@at...> - 2014-04-16 15:05:56
|
Doxygen v1.8.6 Diagnostic Message: SlipWrite.cpp:10: warning: File ended in the middle of a comment block! Perhaps a missing \endcode? Removing the namespace slip { }; or replacing "/*/" with "*/" removes the warning. Namespace seems to work in other contexts and I don't think that "/*/" is a valid Doxygen command. Is this a bug? ================== code ================== namespace slip { void SlipWrite::fitOutput(string& str) { static const char xTable[256] = { /* sp ! " # $ % & ' ( ) * + - , . /*/ SPC, IGN, QUO, IGN, IGN, IGN, IGN, CHR, IGN, IGN, IGN, IGN, IGN, IGN, IGN, 0, }; }; // void SlipWrite::fitOutput(string& str) }; |
From: Stephen G. <Ste...@me...> - 2014-04-15 17:25:59
|
I'm working on setting up Doxygen to run on our build machines every time we compile one of our projects, and one of the requirements I have to work around is moving all of our Doxygen output files to a shared network drive location that all users have access to. Most of the Doxygen generation works fine in this regard, however I am having a difficult time trying to understand how to link up a tagfile generated from our main engine in each of our various projects. I can get it to work fine when they are located on the same drive: TAGFILES = "/SSIIIDocs/DoxygenFiles/$(ENGINE_NAME)/SharedSource/sharedsource.tag = /SSIIIDocs/DoxygenFiles/$(ENGINE_NAME)/SharedSource " However no matter what I've tried to specify a network location it fails to find it. My most recent attempt is this: TAGFILES = \\networkDrive\SSIIIDocs\DoxygenFiles\$(ENGINE_NAME)\SharedSource\sharedsource.tag = \\networkDrive \SSIIIDocs\DoxygenFiles\$(ENGINE_NAME)\SharedSource Am I missing something on how to properly set this up or is it not possible to link to a tagfile located on a network drive at the time of generation? Any help would be greatly appreciated. |
From: Edward M. <Edw...@ce...> - 2014-04-15 14:25:43
|
Doh! Thank you - that was it. Cheers, Ed On 15 Apr 2014, at 16:21, Albert <alb...@gm...<mailto:alb...@gm...>> wrote: Hi Ed, How about adding const a the end of the copydoc of summaryValue? Albert On Tue, Apr 15, 2014 at 3:57 PM, Edward Moyse <Edw...@ce...<mailto:Edw...@ce...>> wrote: Hi all, I don't know if I'm being stupid here, but when I run Doxygen (1.8.2) on the following: /// Accessor for TrackSummary values. bool summaryValue(uint8_t& value, const SummaryType &information) const; /// @copydoc TrackParticle_v1::summaryValue(uint8_t& value, const SummaryType &information) bool summaryValue(float& value, const SummaryType &information) const; /// Set method for TrackSummary values. void setSummaryValue(uint8_t& value, const SummaryType &information); /// @copydoc TrackParticle_v1::setSummaryValue(uint8_t& value, const SummaryType &information) void setSummaryValue(float& value, const SummaryType &information); I get told: /afs/cern.ch/user/e/emoyse/public/AtlasOffline-rel_2/Event/xAOD/xAODTracking/xAODTracking/versions/TrackParticle_v1.h:236:<http://cern.ch/user/e/emoyse/public/AtlasOffline-rel_2/Event/xAOD/xAODTracking/xAODTracking/versions/TrackParticle_v1.h:236:> warning: target TrackParticle_v1::summaryValue(uint8_t& value, const SummaryType &information) of \copydoc command not found I can't see any reason why setSummaryValue(...) would work fine, but summaryValue(...) wouldn't! Cheers, Ed ------------------------------------------------------------------------------ Learn Graph Databases - Download FREE O'Reilly Book "Graph Databases" is the definitive new guide to graph databases and their applications. Written by three acclaimed leaders in the field, this first edition is now available. Download your free book today! http://p.sf.net/sfu/NeoTech _______________________________________________ Doxygen-users mailing list Dox...@li...<mailto:Dox...@li...> https://lists.sourceforge.net/lists/listinfo/doxygen-users |
From: Albert <alb...@gm...> - 2014-04-15 14:21:59
|
Hi Ed, How about adding const a the end of the copydoc of summaryValue? Albert On Tue, Apr 15, 2014 at 3:57 PM, Edward Moyse <Edw...@ce...> wrote: > Hi all, > > I don't know if I'm being stupid here, but when I run Doxygen (1.8.2) on > the following: > > /// Accessor for TrackSummary values. > bool summaryValue(uint8_t& value, const SummaryType &information) > const; > /// @copydoc TrackParticle_v1::summaryValue(uint8_t& value, const > SummaryType &information) > bool summaryValue(float& value, const SummaryType &information) > const; > /// Set method for TrackSummary values. > void setSummaryValue(uint8_t& value, const SummaryType > &information); > /// @copydoc TrackParticle_v1::setSummaryValue(uint8_t& value, const > SummaryType &information) > void setSummaryValue(float& value, const SummaryType &information); > > I get told: > /afs/ > cern.ch/user/e/emoyse/public/AtlasOffline-rel_2/Event/xAOD/xAODTracking/xAODTracking/versions/TrackParticle_v1.h:236:warning: target TrackParticle_v1::summaryValue(uint8_t& value, const > SummaryType &information) of \copydoc command not found > > I can't see any reason why setSummaryValue(...) would work fine, but > summaryValue(...) wouldn't! > > Cheers, > > Ed > > > > ------------------------------------------------------------------------------ > Learn Graph Databases - Download FREE O'Reilly Book > "Graph Databases" is the definitive new guide to graph databases and their > applications. Written by three acclaimed leaders in the field, > this first edition is now available. Download your free book today! > http://p.sf.net/sfu/NeoTech > _______________________________________________ > Doxygen-users mailing list > Dox...@li... > https://lists.sourceforge.net/lists/listinfo/doxygen-users > > |
From: Edward M. <Edw...@ce...> - 2014-04-15 13:57:36
|
Hi all, I don't know if I'm being stupid here, but when I run Doxygen (1.8.2) on the following: /// Accessor for TrackSummary values. bool summaryValue(uint8_t& value, const SummaryType &information) const; /// @copydoc TrackParticle_v1::summaryValue(uint8_t& value, const SummaryType &information) bool summaryValue(float& value, const SummaryType &information) const; /// Set method for TrackSummary values. void setSummaryValue(uint8_t& value, const SummaryType &information); /// @copydoc TrackParticle_v1::setSummaryValue(uint8_t& value, const SummaryType &information) void setSummaryValue(float& value, const SummaryType &information); I get told: /afs/cern.ch/user/e/emoyse/public/AtlasOffline-rel_2/Event/xAOD/xAODTracking/xAODTracking/versions/TrackParticle_v1.h:236:<http://cern.ch/user/e/emoyse/public/AtlasOffline-rel_2/Event/xAOD/xAODTracking/xAODTracking/versions/TrackParticle_v1.h:236:> warning: target TrackParticle_v1::summaryValue(uint8_t& value, const SummaryType &information) of \copydoc command not found I can't see any reason why setSummaryValue(...) would work fine, but summaryValue(...) wouldn't! Cheers, Ed |
From: Michael L. <lan...@gm...> - 2014-04-09 20:37:40
|
Thanks for the response. I guess I was just surprised because Doxygen seemed to cope so well with the rest of the managed C++ language features (including 'sealed' on methods). FYI, I tested and Doxygen does indeed understand 'final', but unfortunately I can't really switch to using final as you're supposed to use 'sealed' for 'ref' classes (http://msdn.microsoft.com/en-us/library/0w2w91tf.aspx). I should be able to mitigate the issue with an INPUT_FILTER, but would be willing to contribute an actual fix if managed C++ is meant to be fully supported. The documentation doesn't seem to make that clear (or my grep-fu is weak). Thanks, Mike On Wed, Apr 9, 2014 at 10:32 AM, Erik Zeek <ze...@ma...> wrote: > On Wed, Apr 9, 2014 at 10:46 AM, Michael Lanzetta <lan...@gm...> wrote: >> Hey all, >> >> I'm running version 1.8.6, and I've noticed that classes marked >> 'sealed' have the name 'sealed' instead of their actual name used, >> when generating C++ documentation. This is odd, since sealed methods >> don't have the same issue. >> For instance: >> >> public ref class MySealed sealed >> { >> public: >> MySealed() >> { >> } >> >> virtual void SealedMethod() sealed {} >> }; >> >> Generates the "class" 'sealed' instead of MySealed, but that class has >> the SealedMethod method. >> >> I've submitted a bug to the bugzilla DB (725183) but so far it's been >> untouched, but I'm hoping you'll tell me it's a PEBKAC issue and >> there's a hidden configuration option I missed that fixes the problem. >> If not, has anyone else seen this (and if so do you have a >> workaround)? >> >> Thanks, >> Mike > > > "sealed" is not part of C++. It's a nonstandard MS extension. > > You can probably use the preprocessor to convert it to final (new in > C++11, not sure if doxygen understands it yet). > > Erik > > -- > ************************************************* > Erik Zeek > ze...@ma... > ************************************************* > Against stupidity the very gods > Themselves contend in vain. > - Johann Christoph Friedrich von Schiller (1801) > ************************************************* |
From: Erik Z. <ze...@ma...> - 2014-04-09 17:32:34
|
On Wed, Apr 9, 2014 at 10:46 AM, Michael Lanzetta <lan...@gm...> wrote: > Hey all, > > I'm running version 1.8.6, and I've noticed that classes marked > 'sealed' have the name 'sealed' instead of their actual name used, > when generating C++ documentation. This is odd, since sealed methods > don't have the same issue. > For instance: > > public ref class MySealed sealed > { > public: > MySealed() > { > } > > virtual void SealedMethod() sealed {} > }; > > Generates the "class" 'sealed' instead of MySealed, but that class has > the SealedMethod method. > > I've submitted a bug to the bugzilla DB (725183) but so far it's been > untouched, but I'm hoping you'll tell me it's a PEBKAC issue and > there's a hidden configuration option I missed that fixes the problem. > If not, has anyone else seen this (and if so do you have a > workaround)? > > Thanks, > Mike "sealed" is not part of C++. It's a nonstandard MS extension. You can probably use the preprocessor to convert it to final (new in C++11, not sure if doxygen understands it yet). Erik -- ************************************************* Erik Zeek ze...@ma... ************************************************* Against stupidity the very gods Themselves contend in vain. - Johann Christoph Friedrich von Schiller (1801) ************************************************* |
From: Michael L. <lan...@gm...> - 2014-04-09 16:46:45
|
Hey all, I'm running version 1.8.6, and I've noticed that classes marked 'sealed' have the name 'sealed' instead of their actual name used, when generating C++ documentation. This is odd, since sealed methods don't have the same issue. For instance: public ref class MySealed sealed { public: MySealed() { } virtual void SealedMethod() sealed {} }; Generates the "class" 'sealed' instead of MySealed, but that class has the SealedMethod method. I've submitted a bug to the bugzilla DB (725183) but so far it's been untouched, but I'm hoping you'll tell me it's a PEBKAC issue and there's a hidden configuration option I missed that fixes the problem. If not, has anyone else seen this (and if so do you have a workaround)? Thanks, Mike |
From: John Y. <jo...@ya...> - 2014-04-08 19:58:33
|
On Tue, Apr 8, 2014 at 3:21 PM, Robert Dailey <rcd...@gm...>wrote: ... > however I'd like to see easier ways to do this in the future, such as: > ... > - "Smart" parsing that determines if there is any "meaningful" content > in a namespace before parsing it out. > Hear! Hear! Though clearly an issue of semantics, not parsing. /john |
From: Robert D. <rcd...@gm...> - 2014-04-08 19:21:46
|
Thanks Dimitri. I elected to go with EXCLUDE_SYMBOLS, however I'd like to see easier ways to do this in the future, such as: - An @exclude tag, which is effectively the same as @cond .. @endcond but only for the single entity the documentation block applies to - "Smart" parsing that determines if there is any "meaningful" content in a namespace before parsing it out. Great work! On Tue, Apr 8, 2014 at 1:53 PM, Dimitri van Heesch <do...@gm...> wrote: > > On 08 Apr 2014, at 15:33 , Robert Dailey <rcd...@gm...> wrote: > >> In my code I have a couple of forward declarations of classes in other >> distant, unrelated namespaces: >> >> namespace foo >> { >> class bar; >> } >> >> These get parsed out by Doxygen (v1.8.6) and appear empty in the HTML >> output. Is there a way that Doxygen can be "smart" enough to ignore a >> namespace if there isn't anything tangible inside of it? It would have >> to know to ignore them if they are empty or only contain forward >> declarations. > > You can: > - not document the namespace and set EXTRACT_ALL to NO > - use EXCLUDE_SYMBOLS = foo > - surround the namespace with /// @cond ... /// @endcond > - surround the namespace with #ifndef DOXYGEN_SKIP ... #endif and set PREDEFINED = DOXYGEN_SKIP > > Regards, > Dimitri |
From: Dimitri v. H. <do...@gm...> - 2014-04-08 19:11:39
|
On 08 Apr 2014, at 15:33 , Robert Dailey <rcd...@gm...> wrote: > In my code I have a couple of forward declarations of classes in other > distant, unrelated namespaces: > > namespace foo > { > class bar; > } > > These get parsed out by Doxygen (v1.8.6) and appear empty in the HTML > output. Is there a way that Doxygen can be "smart" enough to ignore a > namespace if there isn't anything tangible inside of it? It would have > to know to ignore them if they are empty or only contain forward > declarations. You can: - not document the namespace and set EXTRACT_ALL to NO - use EXCLUDE_SYMBOLS = foo - surround the namespace with /// @cond ... /// @endcond - surround the namespace with #ifndef DOXYGEN_SKIP ... #endif and set PREDEFINED = DOXYGEN_SKIP Regards, Dimitri |
From: Robert D. <rcd...@gm...> - 2014-04-08 13:34:11
|
In my code I have a couple of forward declarations of classes in other distant, unrelated namespaces: namespace foo { class bar; } These get parsed out by Doxygen (v1.8.6) and appear empty in the HTML output. Is there a way that Doxygen can be "smart" enough to ignore a namespace if there isn't anything tangible inside of it? It would have to know to ignore them if they are empty or only contain forward declarations. Thanks. |
From: Antonomase <en...@bt...> - 2014-03-27 17:38:13
|
Hi, Is it possible to have a list of all the files referenced by a \version number ? Thanks -- View this message in context: http://doxygen.10944.n7.nabble.com/X-ref-for-version-tp6578.html Sent from the Doxygen - Users mailing list archive at Nabble.com. |
From: Albert <alb...@gm...> - 2014-03-26 18:04:36
|
Did you have a look at the commands like @if and @cond? Albert On Tue, Mar 25, 2014 at 10:26 PM, rpj <rpj...@gm...> wrote: > Hi all, > > Currently when I run doxygen (on C# project) it extracts nicely public > member functions, properties, detailed description (those I need) + > Constructor/Desctructor documentation, Member function documentation and > Property documentation which I would like to exclude since this info is > redundant and it is making documents harder to read (the most important > details and descriptions are already covered in the first section). > > How I can configure doxygen to exclude those sections? > > Thanks, > R > > > > -- > View this message in context: > http://doxygen.10944.n7.nabble.com/Is-it-possible-to-remove-some-sections-from-the-HTML-document-tp6576.html > Sent from the Doxygen - Users mailing list archive at Nabble.com. > > > ------------------------------------------------------------------------------ > Learn Graph Databases - Download FREE O'Reilly Book > "Graph Databases" is the definitive new guide to graph databases and their > applications. Written by three acclaimed leaders in the field, > this first edition is now available. Download your free book today! > http://p.sf.net/sfu/13534_NeoTech > _______________________________________________ > Doxygen-users mailing list > Dox...@li... > https://lists.sourceforge.net/lists/listinfo/doxygen-users > |
From: rpj <rpj...@gm...> - 2014-03-25 21:26:45
|
Hi all, Currently when I run doxygen (on C# project) it extracts nicely public member functions, properties, detailed description (those I need) + Constructor/Desctructor documentation, Member function documentation and Property documentation which I would like to exclude since this info is redundant and it is making documents harder to read (the most important details and descriptions are already covered in the first section). How I can configure doxygen to exclude those sections? Thanks, R -- View this message in context: http://doxygen.10944.n7.nabble.com/Is-it-possible-to-remove-some-sections-from-the-HTML-document-tp6576.html Sent from the Doxygen - Users mailing list archive at Nabble.com. |
From: rpj <rpj...@gm...> - 2014-03-25 21:19:37
|
Hi all, I am using C# for my projects and this is how my code and comments are structured. /*! * Here I would have class description * Author * Properties * Prop 1 description * Prop 2 description */ using System; using System.Collections.Generic; using System.Linq; using System.Text; namespace Example.Doxygen.Sample { class Sample { public Sample() { } public int Prop1 { get; set; } public string Prop2 { get; set; } } } Is there a way to configure doxygen to get those comments as class description or I have to have them just above the class name? I am aware that I could do it this way and it works fine: using System; using System.Collections.Generic; using System.Linq; using System.Text; namespace Example.Doxygen.Sample { /*! * Here I would have class description * Author */ class Sample { public Sample() { } /// <summary> /// Description of Prop 1 /// </summary> public int Prop1 { get; set; } /// <summary> /// Description of Prop 2 /// </summary> public string Prop2 { get; set; } } } But i have so many files that i would have to update that i am trying to find a different solution. Thanks, R -- View this message in context: http://doxygen.10944.n7.nabble.com/C-getting-class-description-tp6575.html Sent from the Doxygen - Users mailing list archive at Nabble.com. |
From: Maciej W <tri...@gm...> - 2014-03-24 15:29:41
|
Hi, because I don't know if it's possible to respond to this topic: https://sourceforge.net/p/doxygen/mailman/message/23755162/ I've created a new one. Lets suppose that the following options were set in doxyfile: EXTRACT_ALL = YES HAVE_DOT = YES CALL_GRAPH = YES CALLER_GRAPH = YES SOURCE_BROWSER = YES USE_HTAGS = NO and we're generating the documentation for the following source code: int fun1() ; int fun2() ; int fun3() ; int main() { fun1(); fun2(); fun3(); } int fun1() { fun2(); } int fun2() { fun3(); } int fun3() { return 2 + 2; } When USE_HTAGS is set to NO, call and caller graphs are part o fthe documentation. When USE_HTAGS = YES, there are _no_ call / caller graphs in the documentation. This looks like a bug but I'm not sure. Cheers. |
From: Maciej W <tri...@gm...> - 2014-03-24 15:24:20
|
Thanks very much for resolving the issue. On Sun, Mar 23, 2014 at 11:07 AM, Albert <alb...@gm...> wrote: > Thanks. > The hhp file is generated by doxygen itself and unfortunately not > recreated when decompiling the chm file. > I'll see what I can do in respect to creating a patch and which > recommendations for generating the doxygen manual I can give. > > Albert > > > On Sat, Mar 22, 2014 at 6:31 PM, TP <wi...@gm...> wrote: > >> On Sat, Mar 22, 2014 at 8:00 AM, Albert <alb...@gm...> wrote: >> >>> My experience (Windows 7 IE9) with the different chm files: >>> - doxygen font button present but doesn't do anything, <cntrl>++ etc >>> don't do anything >>> - total commander font button works, <cntrl>++ etc don't do anything >>> Enable "Options" -> "Internet Options .." -> "General" -> >>> "Accessibility" -> "Ignore font sizes specified on webpages": >>> - doxygen font button works, <cntrl>++ etc don't do anything >>> - total commander font button works, <cntrl>++ etc don't do anything (no >>> change) >>> Had a look at the total commander chm file and content but didn't see >>> something that makes the "Font button" work. I also studied the links TP >>> supplied (thanks) but no new insights except the sentence "*Note: * If >>> you check *Zoom*, also specify relative units for font sizes in CSS; >>> see §9.4.1 *Using CSS and font tags with HTML Help*<http://www.mif2go.com/xhtml/htmlhelp_0014_941usingcssandfonttagswithhtmlhelp.htm#Rz108x49537>." >>> from the first reference, but could not find anything how to apply this. >>> >>> Albert >>> >>> >>> On Sat, Mar 22, 2014 at 3:07 PM, TP <wi...@gm...> wrote: >>> >>>> >>>> On Sat, Mar 22, 2014 at 3:42 AM, Maciej W <tri...@gm...> wrote: >>>> >>>>> Ctrl++/- fail for me in the standard Windows CHM viewer while the >>>>> doxygen help file is opened (Windows XP SP3). Also, the Font button is >>>>> visible, but nothing happens upon clicking on it. >>>> >>>> >>>> Just tried the doxygen 1.8.6 CHM, and Ctrl++/Ctrl+-/Ctrl+0 (reset font >>>> size) work for me on Windows 7 (and IE11 which I believe is what actually >>>> displays the pages?). You have to make sure to first click in the main area >>>> of the CHM viewer to set the keyboard focus --- otherwise the focus by >>>> default is the left side Contest/Search/Favorites area and those keys won't >>>> work. >>>> >>>> You are right, the Font button is visible but does nothing. >>>> >>> >>> >> [Resending to list] >> >> I decompiled the doxygen 1.8.6 CHM (but had to create my own .hhp project >> file because I guess that doesn't get decompiled?). Anyway, what "22.8.3 >> Specifying CSS size values and units of measurement" [1] says is: >> >> >> " >> if you are generating HTML Help and you want to enable the Font >> button on the toolbar, font sizes are best expressed in em >> units. Relative units (em, ex, and %) are based on whatever absolute >> unit (pt, pc, in, cm, mm, or px) is used for the font-size property >> of the <body> tag entry; >> " >> >> >> So, I just modified doxygen_manual.css and changed: >> >> body, table, div, p, dl { >> font-family: Lucida Grande, Verdana, Geneva, Arial, sans-serif; >> font-size: 13px; >> line-height: 1.3; >> } >> >> to: >> >> body, table, div, p, dl { >> font-family: Lucida Grande, Verdana, Geneva, Arial, sans-serif; >> line-height: 1.3; >> } >> >> Regenerating the CHM then makes the Font size button work (and Ctrl+= or >> Ctrl++,Ctrl+-,Ctrl+0 still work). And by doing the little trick mentioned >> in "Adding tabs and toolbar buttons to HTML Help" [2] I also added the Next >> / Previous buttons. that allow the use of the Alt+Down / Alt+Up keys. >> >> BTW, you can use F6 to switch the focus between the Navigation pane and >> the main window. >> >> It would probably be better to change all font-size specifications in the >> .css from px to em but doing only the above basically works (I didn't check >> very carefully). >> >> [1] >> http://www.mif2go.com/xhtml/htmlcss_0030_2283specifyingcsssizevaluesandunitsofmeasurement.htm#Rz121x63678 >> >> [2] >> http://www.mif2go.com/xhtml/htmlhelp_0016_943addingtabsandtoolbarbuttonstohtmlhelp.htm#Rz108x95873 >> >> > > > ------------------------------------------------------------------------------ > Learn Graph Databases - Download FREE O'Reilly Book > "Graph Databases" is the definitive new guide to graph databases and their > applications. Written by three acclaimed leaders in the field, > this first edition is now available. Download your free book today! > http://p.sf.net/sfu/13534_NeoTech > _______________________________________________ > Doxygen-users mailing list > Dox...@li... > https://lists.sourceforge.net/lists/listinfo/doxygen-users > > |
From: Albert <alb...@gm...> - 2014-03-23 10:08:02
|
Thanks. The hhp file is generated by doxygen itself and unfortunately not recreated when decompiling the chm file. I'll see what I can do in respect to creating a patch and which recommendations for generating the doxygen manual I can give. Albert On Sat, Mar 22, 2014 at 6:31 PM, TP <wi...@gm...> wrote: > On Sat, Mar 22, 2014 at 8:00 AM, Albert <alb...@gm...> wrote: > >> My experience (Windows 7 IE9) with the different chm files: >> - doxygen font button present but doesn't do anything, <cntrl>++ etc >> don't do anything >> - total commander font button works, <cntrl>++ etc don't do anything >> Enable "Options" -> "Internet Options .." -> "General" -> "Accessibility" >> -> "Ignore font sizes specified on webpages": >> - doxygen font button works, <cntrl>++ etc don't do anything >> - total commander font button works, <cntrl>++ etc don't do anything (no >> change) >> Had a look at the total commander chm file and content but didn't see >> something that makes the "Font button" work. I also studied the links TP >> supplied (thanks) but no new insights except the sentence "*Note: * If >> you check *Zoom*, also specify relative units for font sizes in CSS; see §9.4.1 >> *Using CSS and font tags with HTML Help*<http://www.mif2go.com/xhtml/htmlhelp_0014_941usingcssandfonttagswithhtmlhelp.htm#Rz108x49537>." >> from the first reference, but could not find anything how to apply this. >> >> Albert >> >> >> On Sat, Mar 22, 2014 at 3:07 PM, TP <wi...@gm...> wrote: >> >>> >>> On Sat, Mar 22, 2014 at 3:42 AM, Maciej W <tri...@gm...> wrote: >>> >>>> Ctrl++/- fail for me in the standard Windows CHM viewer while the >>>> doxygen help file is opened (Windows XP SP3). Also, the Font button is >>>> visible, but nothing happens upon clicking on it. >>> >>> >>> Just tried the doxygen 1.8.6 CHM, and Ctrl++/Ctrl+-/Ctrl+0 (reset font >>> size) work for me on Windows 7 (and IE11 which I believe is what actually >>> displays the pages?). You have to make sure to first click in the main area >>> of the CHM viewer to set the keyboard focus --- otherwise the focus by >>> default is the left side Contest/Search/Favorites area and those keys won't >>> work. >>> >>> You are right, the Font button is visible but does nothing. >>> >> >> > [Resending to list] > > I decompiled the doxygen 1.8.6 CHM (but had to create my own .hhp project > file because I guess that doesn't get decompiled?). Anyway, what "22.8.3 > Specifying CSS size values and units of measurement" [1] says is: > > > " > if you are generating HTML Help and you want to enable the Font > button on the toolbar, font sizes are best expressed in em > units. Relative units (em, ex, and %) are based on whatever absolute > unit (pt, pc, in, cm, mm, or px) is used for the font-size property > of the <body> tag entry; > " > > > So, I just modified doxygen_manual.css and changed: > > body, table, div, p, dl { > font-family: Lucida Grande, Verdana, Geneva, Arial, sans-serif; > font-size: 13px; > line-height: 1.3; > } > > to: > > body, table, div, p, dl { > font-family: Lucida Grande, Verdana, Geneva, Arial, sans-serif; > line-height: 1.3; > } > > Regenerating the CHM then makes the Font size button work (and Ctrl+= or > Ctrl++,Ctrl+-,Ctrl+0 still work). And by doing the little trick mentioned > in "Adding tabs and toolbar buttons to HTML Help" [2] I also added the Next > / Previous buttons. that allow the use of the Alt+Down / Alt+Up keys. > > BTW, you can use F6 to switch the focus between the Navigation pane and > the main window. > > It would probably be better to change all font-size specifications in the > .css from px to em but doing only the above basically works (I didn't check > very carefully). > > [1] > http://www.mif2go.com/xhtml/htmlcss_0030_2283specifyingcsssizevaluesandunitsofmeasurement.htm#Rz121x63678 > > [2] > http://www.mif2go.com/xhtml/htmlhelp_0016_943addingtabsandtoolbarbuttonstohtmlhelp.htm#Rz108x95873 > > |
From: TP <wi...@gm...> - 2014-03-22 17:32:47
|
On Sat, Mar 22, 2014 at 8:00 AM, Albert <alb...@gm...> wrote: > My experience (Windows 7 IE9) with the different chm files: > - doxygen font button present but doesn't do anything, <cntrl>++ etc don't > do anything > - total commander font button works, <cntrl>++ etc don't do anything > Enable "Options" -> "Internet Options .." -> "General" -> "Accessibility" > -> "Ignore font sizes specified on webpages": > - doxygen font button works, <cntrl>++ etc don't do anything > - total commander font button works, <cntrl>++ etc don't do anything (no > change) > Had a look at the total commander chm file and content but didn't see > something that makes the "Font button" work. I also studied the links TP > supplied (thanks) but no new insights except the sentence "*Note: * If > you check *Zoom*, also specify relative units for font sizes in CSS; see §9.4.1 > *Using CSS and font tags with HTML Help*<http://www.mif2go.com/xhtml/htmlhelp_0014_941usingcssandfonttagswithhtmlhelp.htm#Rz108x49537>." > from the first reference, but could not find anything how to apply this. > > Albert > > > On Sat, Mar 22, 2014 at 3:07 PM, TP <wi...@gm...> wrote: > >> >> On Sat, Mar 22, 2014 at 3:42 AM, Maciej W <tri...@gm...> wrote: >> >>> Ctrl++/- fail for me in the standard Windows CHM viewer while the >>> doxygen help file is opened (Windows XP SP3). Also, the Font button is >>> visible, but nothing happens upon clicking on it. >> >> >> Just tried the doxygen 1.8.6 CHM, and Ctrl++/Ctrl+-/Ctrl+0 (reset font >> size) work for me on Windows 7 (and IE11 which I believe is what actually >> displays the pages?). You have to make sure to first click in the main area >> of the CHM viewer to set the keyboard focus --- otherwise the focus by >> default is the left side Contest/Search/Favorites area and those keys won't >> work. >> >> You are right, the Font button is visible but does nothing. >> > > [Resending to list] I decompiled the doxygen 1.8.6 CHM (but had to create my own .hhp project file because I guess that doesn't get decompiled?). Anyway, what "22.8.3 Specifying CSS size values and units of measurement" [1] says is: " if you are generating HTML Help and you want to enable the Font button on the toolbar, font sizes are best expressed in em units. Relative units (em, ex, and %) are based on whatever absolute unit (pt, pc, in, cm, mm, or px) is used for the font-size property of the <body> tag entry; " So, I just modified doxygen_manual.css and changed: body, table, div, p, dl { font-family: Lucida Grande, Verdana, Geneva, Arial, sans-serif; font-size: 13px; line-height: 1.3; } to: body, table, div, p, dl { font-family: Lucida Grande, Verdana, Geneva, Arial, sans-serif; line-height: 1.3; } Regenerating the CHM then makes the Font size button work (and Ctrl+= or Ctrl++,Ctrl+-,Ctrl+0 still work). And by doing the little trick mentioned in "Adding tabs and toolbar buttons to HTML Help" [2] I also added the Next / Previous buttons. that allow the use of the Alt+Down / Alt+Up keys. BTW, you can use F6 to switch the focus between the Navigation pane and the main window. It would probably be better to change all font-size specifications in the .css from px to em but doing only the above basically works (I didn't check very carefully). [1] http://www.mif2go.com/xhtml/htmlcss_0030_2283specifyingcsssizevaluesandunitsofmeasurement.htm#Rz121x63678 [2] http://www.mif2go.com/xhtml/htmlhelp_0016_943addingtabsandtoolbarbuttonstohtmlhelp.htm#Rz108x95873 |
From: Albert <alb...@gm...> - 2014-03-22 15:00:51
|
My experience (Windows 7 IE9) with the different chm files: - doxygen font button present but doesn't do anything, <cntrl>++ etc don't do anything - total commander font button works, <cntrl>++ etc don't do anything Enable "Options" -> "Internet Options .." -> "General" -> "Accessibility" -> "Ignore font sizes specified on webpages": - doxygen font button works, <cntrl>++ etc don't do anything - total commander font button works, <cntrl>++ etc don't do anything (no change) Had a look at the total commander chm file and content but didn't see something that makes the "Font button" work. I also studied the links TP supplied (thanks) but no new insights except the sentence "*Note: * If you check *Zoom*, also specify relative units for font sizes in CSS; see §9.4.1 *Using CSS and font tags with HTML Help*<http://www.mif2go.com/xhtml/htmlhelp_0014_941usingcssandfonttagswithhtmlhelp.htm#Rz108x49537>." from the first reference, but could not find anything how to apply this. Albert On Sat, Mar 22, 2014 at 3:07 PM, TP <wi...@gm...> wrote: > > On Sat, Mar 22, 2014 at 3:42 AM, Maciej W <tri...@gm...> wrote: > >> Ctrl++/- fail for me in the standard Windows CHM viewer while the doxygen >> help file is opened (Windows XP SP3). Also, the Font button is visible, but >> nothing happens upon clicking on it. > > > Just tried the doxygen 1.8.6 CHM, and Ctrl++/Ctrl+-/Ctrl+0 (reset font > size) work for me on Windows 7 (and IE11 which I believe is what actually > displays the pages?). You have to make sure to first click in the main area > of the CHM viewer to set the keyboard focus --- otherwise the focus by > default is the left side Contest/Search/Favorites area and those keys won't > work. > > You are right, the Font button is visible but does nothing. > |
From: TP <wi...@gm...> - 2014-03-22 14:08:17
|
On Sat, Mar 22, 2014 at 3:42 AM, Maciej W <tri...@gm...> wrote: > Ctrl++/- fail for me in the standard Windows CHM viewer while the doxygen > help file is opened (Windows XP SP3). Also, the Font button is visible, but > nothing happens upon clicking on it. Just tried the doxygen 1.8.6 CHM, and Ctrl++/Ctrl+-/Ctrl+0 (reset font size) work for me on Windows 7 (and IE11 which I believe is what actually displays the pages?). You have to make sure to first click in the main area of the CHM viewer to set the keyboard focus --- otherwise the focus by default is the left side Contest/Search/Favorites area and those keys won't work. You are right, the Font button is visible but does nothing. |