http://blog.gmane.org/gmane.text.doxygen.general hourly 1 1901-01-01T00:00+00:00 http://gmane.org/img/gmane-25t.png http://gmane.org http://comments.gmane.org/gmane.text.doxygen.general/10306 <pre>I'm new to doxygen (everyone has to start sometime, right?) and I've got a question about the use of the \example tag. I have a java source file with this in it: /** * \briefDetermine if the API call has been canceled. * * \return true if the API call was canceled, false if the API call was not canceled. */ public boolean canceled() { return isCanceled; } /** * \example edkresult_canceled_example.js * Some info about the canceled example. */ The file edkresult_canceled_example.js has an example of using the "canceled" method: // edkresult_canceled_example.js function main() { var output = "API Test\n"; var API = new MyApi(); // instantiate the API if (API != null) { // if we have a valid API instance, make our calls var version = API.getVersion(); // get the result of the API call output += "The API call " + (version.canceled() : "was" : "was not") + " canceled.\n"; } return output; </pre> Steve Goodrich 2012-05-23T20:13:07 http://comments.gmane.org/gmane.text.doxygen.general/10305 <pre> Hello all, I have a question to the group, related to my previous question but this time regarding only &lt; at &gt;subpage. I have the same setup I presented in my previous email but I also want the included htmls which come from generated pages to be a subpage to this main doc page. &lt; at &gt;subpage would work nicely except I don't want the link to appear the way all other links appear in the documentation nor do I want it to appear where I write the &lt; at &gt;subpage command. Is there any option to create the &lt; at &gt;subpage link between two pages but without actually having the link appear? What I am using now is a hidden div to achieve it. Any other more doxygen-ish way exists? Here is what I do: /** ** ** &lt;div style="display:none;"&gt; ** &lt; at &gt;subpage ExampleTopic1PGE ** &lt; at &gt;subpage ExampleTopic2PGE ** &lt;/div&gt; **&lt;!-- more stuff above --&gt; ** &lt; at &gt;docsubsection{3.1 ExampleTopic_1} ** &lt; at &gt;docsubpage{ExampleTopic1PGE} ** &lt; at &gt;htmlinclude Doxygen_Html/ExampleTopic1PGE.html ** ** &lt; at &gt;docsubsection{3.2 Example Topic 2} ** &lt; at &gt;docsubpage{ExampleTopic2PGE</pre> Lefteris Karapetsas 2012-05-23T03:05:25 http://comments.gmane.org/gmane.text.doxygen.general/10298 <pre> I'd like to use the Markup technique for creating a table but I need a table without a header (my table is several rows/columns of values and the header would meaningless). Looking at the commands it looks like it insists on treating the first row in a special way. Is there a way around this? </pre> Jake Colman 2012-05-22T12:44:02 http://comments.gmane.org/gmane.text.doxygen.general/10290 <pre>Hi all. I have a setup like this: /** &lt; at &gt;mainpage Name &lt; at &gt;subpage Foo &lt; at &gt;subpage FooBar */ /** &lt; at &gt;page Foo Foo Some text &lt; at &gt;subpage Bar */ /** &lt; at &gt;page Bar Bar Some text */ /** &lt; at &gt;page FooBar Some text &lt; at &gt;section Bar Some more text */ If I generate a doxygen html-docs from this setup, then the subpage link on page Foo links to FooBar’s section Bar instead of to page Bar. However, the link in the treeview correctly links to page Bar. Is this a known bug with known workarounds od do I really have to assure, that all pages, sections, subsections and subsubsections in a project have unique names (which could be quite problematic when generating a doc from multiple projects from different devs)? Thanks, Stefan. ------------------------------------------------------------------------------ Live Security Virtual Conference Exclusive live event will cover all the ways today's security and threat landscape has changed and how IT managers can respond. Discussions will include endpoint secur</pre> Stefan Ludewig 2012-05-21T14:23:59 http://comments.gmane.org/gmane.text.doxygen.general/10282 <pre> Hello all, I have two different and quick questions. Question 1: Using \tableofcontents I am trying to organize the main documentation page of my library but it seems that the indentation of the list gets destroyed after encountering the first &lt; at &gt;subsubsection. In particular all the &lt; at &gt;sections afterwards go to the &lt; at &gt;subsection level. When I checked the \tableofcontents documentation it mentioned only that it works for up to subsections and no more. So I guess this is why this occurs. How can I document a table of contents for more indentation levels? Anyone else aware of this issue? Any way to solve it? I might be forced to: a) either do the ToC manually b) Have all indentation in the page from &lt; at &gt;subsubsection and down with a different custom html tag so that doxygen won't see it and the ToC won't get screwed. Of course that means that the ToC will have only two indentation levels which beats the whole purpose I guess. Question 2: I have a &lt; at &gt;page (not the &lt; at &gt;mainpage) which is the biggest documentation page of</pre> Lefteris Karapetsas 2012-05-20T16:23:45 http://comments.gmane.org/gmane.text.doxygen.general/10281 <pre>Dear All, In the new release there has been a change in respect to handling svg images: When I click on Windows, using the latest version of Firefox, on the arrow a new, empty tab is opened, and I get the message: Firefox doesn't know how to open this address, as the protocol(d) isn't associated with any program. When doing the same in the Internet Explorer a new tab is opened and the svg image is shown. (When doing the same in the older version (printer icon) I got similar messages, but I never used it.) Any suggestions ? Albert ------------------------------------------------------------------------------ Live Security Virtual Conference Exclusive live event will cover all the ways today's security and threat landscape has changed and how IT managers can respond. Discussions will include endpoint security, mobile security and the latest in malware threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/ </pre> Albert 2012-05-20T11:20:44 http://comments.gmane.org/gmane.text.doxygen.general/10279 <pre>Hi, Version 1.8.1 has been released. Here is the changelog since the last SVN update: ------------------------------------------------------------------------------ + BUG: id 674583: Fortran: continuation by ampersand not placed in code output. + ADD: A -- will now be rendered as an 'en dash', similar --- will produce an mdash. + BUG: id 673870: Added C++11 classes when BUILTIN_STL_SUPPORT is enabled. + CHG: Added natural scrolling for tablet devices (like the iPad) when using the treeview. + BUG: id 673983: Using a backslash in a section cause 026E30F to appear in the latex TOC. + BUG: id 675757: Fixed indenting issue after the end of a markdown code block inside a list. + BUG: id 523156: Fortran: Prefix of routines got stripped. + BUG: id 676294: Fixed LaTeX error when backslash appeared in a hyperlinked code fragment. + BUG: id 671166: Fortran: Fixed problem causing call/caller graphs not to be generated. + ADD: id 676116: Use new index style for page index. + C</pre> Dimitri van Heesch 2012-05-19T12:22:43 http://comments.gmane.org/gmane.text.doxygen.general/10278 <pre>I was wondering if there is any way to hide the main page. I have tried setting the visible property for the mainpage in the DoxygenLayout.xml to no, but the main page navigation tab always shows up. Thanks in advance for your help, Deep ------------------------------------------------------------------------------ Live Security Virtual Conference Exclusive live event will cover all the ways today's security and threat landscape has changed and how IT managers can respond. Discussions will include endpoint security, mobile security and the latest in malware threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/ </pre> Jasdeep Saini 2012-05-19T02:54:56 http://comments.gmane.org/gmane.text.doxygen.general/10277 <pre> I am trying to figure out how to use Tag Files to link to external documentation that is available for the third party libraries that I am using, specifically Qt and Roguewave SourcePro. For both libraries I have access to their source code. Both libraries also provide beautiful documentation on their respective web sites. In Roguwave's case I'm almost certain it was produced by some version of Doxygen. What is the recommended way to include Roguwave's and Qt's documentation in to my own documentation so that I process Roguwave and Qt only once? Do I have to first run Doxygen against the third-party source code? Doxygen's manual seems to imply that you can link to external documentation even if you do not have the original source code? Also, if I have to process the source code, what is the value of the URL option to the tag file? Can someone please point me to the correct approach for getting Roguwave and Qt to link with my own documentation? Thanks. ...Jake </pre> Jake Colman 2012-05-17T12:15:40 http://comments.gmane.org/gmane.text.doxygen.general/10275 <pre>Hi,  I am not able to use the symbol \triangledown which are part of amssymb package in  latex. Document generation fails. It is possible to specify which packages to use in doxygen? Thanks, Venkatesh ------------------------------------------------------------------------------ Live Security Virtual Conference Exclusive live event will cover all the ways today's security and threat landscape has changed and how IT managers can respond. Discussions will include endpoint security, mobile security and the latest in malware threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/ </pre> Venkatesh U 2012-05-16T22:46:56 http://comments.gmane.org/gmane.text.doxygen.general/10269 <pre> Normally warnings are generated using the (default) setting "$file:$line: $text", and this normally gives a message in the format: C:\display.c:1768: warning: parameters of member print are not (all) documented However I'm getting one warning that I can't resolve: &lt;&lt; at &gt;6&gt;:1: warning: parameters of member &lt; at &gt;6 are not (all) documented I can't find any way of detecting which line, function, variable etc.. that is causing the above warning. Any suggestions? </pre> BenG 2012-05-11T10:23:16 http://comments.gmane.org/gmane.text.doxygen.general/10267 <pre> Hello, I am working with doxygen 1.8 in Windows using the DoxyWizard. No matter how many combinations or solutions I tried I can't seem to make the aliases work with arguments. According to the manual here http://www.stack.nl/~dimitri/doxygen/custcmd.html I need to add something like: ALIASES += l{1}="\ref \1" I do so and then I try to refer to it by putting \l something in my code. The result is always : warning: Found unknown command `\l' If I add it from inside doxywizard I just write l{1}=\ref \1 If I add it directly to the configuration file I write as was from the example above with ALIASES+= . No matter what I do I get the same result. It is not working for me. Can anyone help me? I have been trying to figure this out since yesterday and I have no idea what the problem might be. Thanks! ------------------------------------------------------------------------------ Live Security Virtual Conference Exclusive live event will cover all the ways today's security and threat landscap</pre> Lefteris Karapetsas 2012-05-11T08:04:41 http://comments.gmane.org/gmane.text.doxygen.general/10265 <pre>Hi Dimitri, The groups html page generated has a tree like display where nested groups are shown via collapsing of tree node. Can the same (tree like view) be implemented for pages and sub-pages. Thanks &amp; Regards, Harpreet Singh ________________________________ NOTE: This message and its attachments are intended only for the individual or entity to which it is addressed and may contain confidential information or forward-looking statements regarding product development. Forward-looking statements are subject to change at Atrenta's sole discretion and Atrenta will have no liability for the delay or failure to deliver any product or feature mentioned in such forward-looking statements. ------------------------------------------------------------------------------ Live Security Virtual Conference Exclusive live event will cover all the ways today's security and threat landscape has changed and how IT managers can respond. Discussions will include endpoint security, mobile security and the latest </pre> Harpreet Singh Anand 2012-05-10T19:40:02 http://comments.gmane.org/gmane.text.doxygen.general/10261 <pre>A project I work on consists of many C and header files, and a single file in a language X that is not supported by Doxygen, to which in the example below I give the name "fireworks.x". There is a requirement to include all source code in the documentation (which is in HTML format). In order to do that I added the comment block below to one of the C files: /** &lt; at &gt;page page99 fireworks.x The file fireworks.x is listed below. For safety reasons it should be used only with permission from local authorities. Warning: fire risk! &lt; at &gt;verbinclude fireworks.x */ The above works well. "fireworks.x" appears prominently in the navigation tree at left, as well as a title at the top of the page. However it would be best if I could somehow have that file not as a loose page but rather listed in the File List in the navigation tree at left. Is there a way to do that? --- I use FILE_VERSION_FILTER to have Doxygen fetch file versions from the SCM. This works for C and header files, but not for "fireworks.x". Is there a wa</pre> Piscium 2012-05-09T23:40:00 http://comments.gmane.org/gmane.text.doxygen.general/10256 <pre>Hi everyone, I haven't found anything about this in the manual, so here we go... We have a lot of Javadoc links to stuff inside e.g. the JDK itself. Naturally, the JDK's official reference documentation isn't generated via doxygen, but by javadoc (as is the case for a lot of pure Java open source libraries). Is there a way to generate links via doxygen to pure Javadoc documentation? If not, is anybody working on this? Obviously, I could download the sources to all the libraries we're using and run doxygen on them, but that would seem like redoing a job that's already been done. So is there a way to achieve this? Mit freundlichen Grüßen / Kind Regards Raimund Klein EDV / Software Entwickler BERENBERG BANK Joh. Berenberg, Gossler &amp; Co. KG Neuer Jungfernstieg 20 20354 Hamburg Telefon +49 40 350 60-8129 Telefax +49 40 350 60-955 E-Mail raimund.klein&lt; at &gt;berenberg.de www.berenberg.de &lt;outbind://75/www.berenberg.de&gt; Sitz: Hamburg - Amtsgericht Hamburg HRA 42659 Diese Nachricht einsc</pre> Klein, Raimund 2012-05-09T07:44:18 http://comments.gmane.org/gmane.text.doxygen.general/10253 <pre>Hello, Can someone familiar with doxygen internals tell me how the internal page links that go from method summary to method documentation are generated? They appear to use some kind of digest for an alphanumeric ID in the form: documentation/class.html#aab5c01f99f53235d4cee8a3bc6374e99 I have users asking me if these links will stay the same over time, but this will only be true if the link IDs are generated based on the method name rather than a seed at the start of the page. Much obliged, Kieron </pre> Kieron Taylor 2012-05-08T14:06:37 http://comments.gmane.org/gmane.text.doxygen.general/10252 <pre> I am using doxygen version 1.8.0 on windows-Xp and somehow it's not been able to generate function call graph for my small c code. Path for dot is set properly. I do not see any error in output log as well. Can somebody suggest something to resolve the issue? Regards, Raj </pre> Raj_freescale 2012-05-08T07:14:40 http://comments.gmane.org/gmane.text.doxygen.general/10251 <pre> Hello, I was wondering if there is any method, using doxygen, that would allow us to get a list of all the children of a certain class. In my case since I use C, I deal with structs a few of which have inheritance-like relationships. To accomplish that I use the doxygen &lt; at &gt;extends command. But now I have found myself wanting to document something like below. Assume we have a parent foo and a child foo. Some of the parent foo's functions are usable with both parent and child but some are not. I needed a way to document this. So far I am hand-coding everything but there has to be another better way. NOW--&gt; //! &lt; at &gt;memberof ParentFoo //! Can be safely used by ChildFoo1, ChildFoo2, e.t.c. foo_func() DESIRED --&gt; //! &lt; at &gt;memberof ParentFoo //! &lt; at &gt;childrencanuse ParentFoo foo_func() I hope I can convey the meaning of what I am looking to accomplish here. Any help would be deeply appreciated. I mean .dot does that somehow when it generates the diagrams. Getting just a list of the children should be possible. Thanks</pre> Lefteris Karapetsas 2012-05-07T10:20:02 http://comments.gmane.org/gmane.text.doxygen.general/10250 <pre>I attempted to split up a few projects using tag files and it mostly worked. I set ALLEXTERNALS to yes, and if I click on a class in a class list that was included via another project's tag file the browser is correctly taken to the documentation for that class. However, the class documentation is shown within that project's doxygen site and not that of the top level project. What I mean by that is if I click on "Main Page" while viewing the class's documentation, I'm taken to the main page for the subproject and not the top level project. Furthermore, the only way I could find to get back to the top level project was to use the back button. Is there a way to navigate back to the top level project from documentation parsed out of a tag file? Secondly, is there some way to have the input files for a tag included in the main file list? Similar to what ALLEXTERNALS does for classes. ------------------------------------------------------------------------------ Live Security Virtual Conference Exclusive</pre> Davidson, Josh 2012-05-07T05:21:25 http://comments.gmane.org/gmane.text.doxygen.general/10248 <pre>Hello, I'm a little lazy to register in order to file a bug properly. If GENERATE_TREEVIEW is enabled (html option) all files of the data structures documentation in Latex output ends with "&lt;/div&gt;&lt;\!-- doc-content --&gt;". I've been looking a little in the code but can't find this bug's origin :-/ Regards, André ------------------------------------------------------------------------------ Live Security Virtual Conference Exclusive live event will cover all the ways today's security and threat landscape has changed and how IT managers can respond. Discussions will include endpoint security, mobile security and the latest in malware threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/ </pre> André Glória 2012-05-04T17:39:47 http://comments.gmane.org/gmane.text.doxygen.general/10246 <pre>Our code base contains 3 main components of code, each essentially its own separate product. However, they are interconnected in that they depend on each other (library A may use objects from library B). Currently we run doxygen once to generate documentation for all 3 components, but this is very time consuming and also creates some issues. For example, each of the 3 components defines its own &lt; at &gt;mainpage documentation, so this creates some weird issues with what is supposed to display on the main page. Can someone recommend a better setup for this? Can I process documentation on each of the 3 separately and have object references between components somehow still linkable by doxygen? Is there a better way to organize component &lt; at &gt;mainpage documentation, so each gets its own page or something? Thanks in advance! ------------------------------------------------------------------------------ Live Security Virtual Conference Exclusive live event will cover all the ways today's security and threat landscape has </pre> Robert Dailey 2012-05-04T14:51:32 Search the mailing list at Gmane query http://search.gmane.org/?group=$group=gmane.text.doxygen.general