gmane.text.doxygen.general

Java exception list warning

J Arrizza — 2013-06-17T23:12:28

Doxygen 1.8.4 running on Ubuntu 12.04 generating RTF parsing Java

Hi,

We just updated to 1.8.4 from 1.6.3. We are now getting warnings from
doxygen:

myproj/src/fmcna/utTestTester/UTestSetupWithExcp.java:19: Warning: missing
(
in exception list on member setup
myproj/src/fmcna/utTestTester/UTestTeardownWithExcp.java:21: Warning:
missing ( in exception list on member teardown

This is on a "throws" in Java source

    19   public void setup() throws Exception
    20     {


Is this a known bug?

John
------------------------------------------------------------------------------
This SF.net email is sponsored by Windows:

Build for Windows Store.

http://p.sf.net/sfu/windows-dev2dev_______________________________________________
Doxygen-users mailing list
Doxygen-users< at >lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users

Re: What is the best way to makeDocumentationpartially?

2013-06-17T08:58:36

Hi Richard,

I had to manage a similar project with a few hundred existing files. The 
project did not have comments in a doxygen style. For documentation I used 
three different cases:
1) I included some new files with new functions to the project. The file 
and the modules had been documented in the doxygen style. The path had 
been added to doxygens INPUT.
2) I included some new functions to existing files. The file header had 
been modified. The file and the new modules had been documented in the 
doxygen style. The existing modules that should not be part of the 
documentation had been marked with \cond \endcond. The path had been added 
to doxygens INPUT.
3) I had to modify just a few lines in an existing function located 
somewhere in the project. The modifications had been marked with some 
(file) unique comments (eg: Modification_001_Start, Modification_001_End) 
. The path had to be included to doxygens EXAMPLE_PATH. I described the 
modifications in a general input file and added the code snippet

Merging doxy output from multiple programminglanguages

Brad Wait — 2013-06-15T00:53:06

Hi

We have several API "wrappers" auto-generated from a C++ source using SWIG. As a result, the APIs are closely related based on the class definitions from the C++.

Right now, we generate the doxygen for each language separately.  Is there a way to integrate these into one system.  Ideally, we want to do something similar to MSDN:  http://msdn.microsoft.com/en-us/library/windows/apps/windows.applicationmodel.package.aspx

Thanks




------------------------------------------------------------------------------
This SF.net email is sponsored by Windows:

Build for Windows Store.

http://p.sf.net/sfu/windows-dev2dev_______________________________________________
Doxygen-users mailing list
Doxygen-users< at >lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users

Re: What is the best way to make Documentationpartially?

Geoff Worboys — 2013-06-14T10:59:50





I've not tried anything like you describe, but what little I've
done with ENABLED_SECTIONS suggests to me that it won't help
much.  Yes it can exclude parts of documentation, but only by
altering that code to surround it by section markers that you
can then NOT define in ENABLED_SECTIONS.  That doesn't really
sound like a good fit to me.

Others with more experience may be able to offer alternatives
but I see two possibilities at the moment:

  1. Keep the INPUT defined to a specific list of files
     (just those you have changed)
or
  2. Create a small program to attach to INPUT_FILTER.
     This program could operate in one of two ways:
       - simply reflect (output directly) files with a
         timestamp beyond when you started work but
         exclude all others
       - parse the file to find a marker you put in the
         ones you are changing and output those but not
         the others

Or maybe a mix of the two.  And in either case you may want to
also use ENABLED_SECTIONS to exclude an

What is the best way to make Documentationpartially?

rrauch — 2013-06-14T09:21:26

Hi Everyone,

we have made a project for customizing an existing WEC7 Board Support
Package for usage at a customer specific hardware development.
Such a BSP is a very huge project, with a lot of subdirectories and files,
common and hardware specific.

Within this project we have created some additional drivers, files and
touched some of the existing files.
For documentation of our work we want to make doxygen documentation only for
parts, we have created or changed.
What is the best way for doing this? (We do not want to touch/add any
doxygen related information to files, we have not worked on).

Could I add any information to our files to tell doxygen to add this file to
documentation, but not to add other files, which do not have this
information?
I found "ENABLED_SECTIONS" but with this functionality I am able to exclude
parts from documentation.

Any ideas?

Thanks Richard



--
View this message in context: http://doxygen.10944.n7.nabble.com/What-is-the-best-way-to-make-Documentation-partially-tp6078.h

Re: doxygen 1.8.4 hangs

Arthur Schwarz — 2013-06-13T21:02:45

Thanks;

What I see in the bug report is that there is a fix and that (I s'pose) release of the fix is imminent. I think I'm going to do some code hunting and see if I can locate the problem in my code and I'm going to take the "cowards way out" and reload 1.8.3.

Great reference. Thanks.
art




________________________________
 From: Albert <albert.tests< at >gmail.com>
To: Arthur Schwarz <aschwarz1309< at >att.net> 
Cc: "doxygen-users< at >lists.sourceforge.net" <doxygen-users< at >lists.sourceforge.net> 
Sent: Thursday, June 13, 2013 11:21 AM
Subject: Re: [Doxygen-users] doxygen 1.8.4 hangs
 


Dear Arthur,

Just remembered, some console output might help as well.
Have also a look at Bug 701295 -Doxygen 1.8.4 goes into an endless loop

Albert




On Thu, Jun 13, 2013 at 8:18 PM, Albert <albert.tests< at >gmail.com> wrote:

Dear Arthur,
This SF.net email is sponsored by Windows:

Build for Windows Store.

http://p.sf.net/sfu/windows-dev2dev_______________________________________________
Doxygen-users mailing list
Doxygen-users< at >l

Re: doxygen 1.8.4 hangs

Albert — 2013-06-13T18:21:24

Dear Arthur,

Just remembered, some console output might help as well.
Have also a look at *Bug
701295*<https://bugzilla.gnome.org/show_bug.cgi?id=701295>- Doxygen
1.8.4 goes into an endless loop

Albert


On Thu, Jun 13, 2013 at 8:18 PM, Albert <albert.tests< at >gmail.com> wrote:

------------------------------------------------------------------------------
This SF.net email is sponsored by Windows:

Build for Windows Store.

http://p.sf.net/sfu/windows-dev2dev_______________________________________________
Doxygen-users mailing list
Doxygen-users< at >lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users

Re: doxygen 1.8.4 hangs

Albert — 2013-06-13T18:18:23

Dear Arthur,

Just a Doxyfile does not give a lot of information, file looks OK though.
A small project showing the problem might be useful. Looks like it is more
data dependent than Doxyfile dependent.

Albert


On Thu, Jun 13, 2013 at 7:50 PM, Arthur Schwarz <aschwarz1309< at >att.net>wrote:

------------------------------------------------------------------------------
This SF.net email is sponsored by Windows:

Build for Windows Store.

http://p.sf.net/sfu/windows-dev2dev_______________________________________________
Doxygen-users mailing list
Doxygen-users< at >lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users

doxygen 1.8.4 hangs

Arthur Schwarz — 2013-06-13T17:50:20

I just installed doxygen 1.8.4 running under Win7 and cygwin. When I execute doxygen in either environment it hangs. I am including my config file w/o comments. I've looked at the file and can't see what I might be doing wrong.

Any help would be appreciated. I'm dead in the water.
------------------------------------------------------------------------------
This SF.net email is sponsored by Windows:

Build for Windows Store.

http://p.sf.net/sfu/windows-dev2dev_______________________________________________
Doxygen-users mailing list
Doxygen-users< at >lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users

Re: C# comments and blank lines

Mats Behre — 2013-06-13T17:35:58

Thanks, the Markdown support isn't something I use anyway, so turning that off  in no problem.

Mats
________________________________
From: kyle< at >allieandkyle.com [kyle< at >allieandkyle.com] on behalf of Kyle Bygott [bygottski< at >hotmail.com]
Sent: 13 June 2013 17:03
To: Mats Behre
Cc: doxygen-users< at >lists.sourceforge.net
Subject: Re: [Doxygen-users] C# comments and blank lines

Mats--
I asked the same question to the list back in May (5/23, subject: "Markdown: Images and paragraph indentation") and never received a response.  One thing I found is that it is related to the new markdown capabilities.

I didn't think of the <br> workaround, another thing you can do is reformat all your comments to not indent.  Another option is to turn off markdown in your doxygen config file (faced with having to scrub through and reformat hundreds of lines of comments, that's what I had to resort to).

I wonder if the image tag is reverting the parser's understanding of indentation so that it then thinks that your line "More text" is

Re: C# comments and blank lines

Kyle Bygott — 2013-06-13T15:03:26

Mats--
I asked the same question to the list back in May (5/23, subject:
"Markdown: Images and paragraph indentation") and never received a
response.  One thing I found is that it is related to the new markdown
capabilities.

I didn't think of the <br> workaround, another thing you can do is reformat
all your comments to not indent.  Another option is to turn off markdown in
your doxygen config file (faced with having to scrub through and reformat
hundreds of lines of comments, that's what I had to resort to).

I wonder if the image tag is reverting the parser's understanding of
indentation so that it then thinks that your line "More text" is indented
can get some closure on it (if it is bugging more ppl than just me,
probably worth it)

--Kyle


On Thu, Jun 13, 2013 at 1:07 AM, Mats Behre <Mats.Behre< at >tritech.se> wrote:

------------------------------------------------------------------------------
This SF.net email is sponsored by Windows:

Build for Windows Store.

http://p.sf.net/sfu/windows-dev2dev______

Re: C# comments and blank lines

Kyle Bygott — 2013-06-13T15:17:44

https://bugzilla.gnome.org/show_bug.cgi?id=702189

--Kyle

On Thu, Jun 13, 2013 at 9:03 AM, Kyle Bygott <bygottski< at >hotmail.com> wrote:

------------------------------------------------------------------------------
This SF.net email is sponsored by Windows:

Build for Windows Store.

http://p.sf.net/sfu/windows-dev2dev_______________________________________________
Doxygen-users mailing list
Doxygen-users< at >lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users

C# comments and blank lines

Mats Behre — 2013-06-13T07:07:08

Hi,

When I have blank lines (starting with ///) in C# comments (for readability in the source file) doxygen in some cases seems to get into a code mode; the following text is put inside a box.
It doesn't always happen, but one situation is after an image.

Example:
        /// <summary>
        ///             Brief text.
        /// </summary>
        /// <remarks>
        ///             Text.
        ///             < at >image html picture.png
        ///
        ///             More text.
        ///     </remarks>
        class Test {
        }


It doesn't matter if the picture exists or not, the result is the same.
If I put a <br/> on the blank line everything is OK, so the issue can be worked around.

Is this a known behaviour, and is it desired for some reason?

Tritech Technology AB

Mats Behre


mats.behre< at >tritech.se
+46 733 45 87 55

www.tritech.se
+46 8 410 120 00
J?rnv?gsgatan 10
PO Box 1094, SE-172 22 Sundbyberg, Sweden


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

Trouble with make pdf

Arthur Schwarz — 2013-06-12T21:48:32

Doxywizard 1.8.3 (doxygen 1.8.3)

I'm trying to make a pdf file without success. In Doxywizrd I have set latex > 'an intermidiate form of hyperlinked pdf' and in expert mode I have set Perlmod 'GENERATE_PERLMOD' and 'PERLMOD_LATEX'.

Using the latest cygwin I execute 'make -d pdf' in the perlmod directory, and get:

GNU Make 3.82.90
Built for i686-pc-cygwin
Copyright (C) 2010  Free Software Foundation, Inc.
License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.
Reading makefiles...
Reading makefile `Makefile'...
Reading makefile `C:/home/skidmarks/Projects/SLIP/DOC/ReferenceManual/perlmod/doxyrules.make' (search path) (no ~ expans
ion)...
C:/home/skidmarks/Projects/SLIP/DOC/ReferenceManual/perlmod/doxyrules.make:29: *** multiple target patterns.  Stop.

I am including the Makefile and doxyrules.make files. Any idea what I'm doing wrong?

art------------------------

Re: Escaping period character (.)

Brian Buttolph — 2013-06-12T15:26:50

<tt>\%ACCUREV_HOME\%\\\.accurev\Logs\ShowTriggers-YYYY-MM-DD.log</tt>

displays correctly when in a \page section as:

%ACCUREV_HOME%\.accurev\Logs\ShowTriggers-YYYY-MM-DD.log

but not in a \brief section where it displays without the separator:

%ACCUREV_HOME%.accurev\Logs\ShowTriggers-YYYY-MM-DD.log




--
View this message in context: http://doxygen.10944.n7.nabble.com/Escaping-period-character-tp3545p6068.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

------------------------------------------------------------------------------
This SF.net email is sponsored by Windows:

Build for Windows Store.

http://p.sf.net/sfu/windows-dev2dev

"...terminate it in an unusual way."

Brian Henning — 2013-06-10T15:38:57

Hi,

 

Sadly I am not sure which config change led to the start of the problem, but
I am now seeing Doxygen 1.8.3.1 bail like so:

 

[...]

Computing class relations...

Add enum values to enums...

 

This application has requested the Runtime to terminate it in an unusual
way.

Please contact the application's support team for more information.



The warning log file just terminates abrubtly in the middle of whining about
not finding included system headers:

 

C:/Users/bhenning/Documents/Sandbox/tagged_parameters/include/basic_types.h:
32: Warning: include file exception not found, perhaps you forgot to add its
directory to INCLUDE_PATH?

C:/Users/bhenning/Documents/Sandbox/tagged_parameters/include/collections.h:
34: Warning: include file vector not found, perhaps you forgot to add its
directory to INCLUDE_PATH?

C:/Users/bhenning/Documents/Sandbox/tagged_parameters/include/collections.h:
35: Warning: include f

 

That's not a copy-paste error.  It ends just like that, "Warning: include f"

 

What

Re: Warning from ":1"

Sam Varshavchik — 2013-06-10T12:37:55


Templates and ordinary classes have different semantics, and are not really  
replacements for each other. Making the inheritance a regular class, of  
course, makes this ordinary inheritance, which has no issues.


Well, that's as much as I can pare down. Can't really get any more bare than  
two headers, with one class or template declared in each, and a pair of  
Doxyfiles containining only two non-default settings.


I don't have anything for the include path. The external headers are in  
/usr/include.

For the simple test case, replacing the include with #include  
<proj1/vector.H> and then adding the INCLUDE_PATH so that the external  
header can be found, that makes no difference. The warning still gets issued.

What does make the warning go away is leaving the template declaration as  
is, but replacing the inheritance with 'class derived : public vector'. That  
makes the warning go away, but, of course, that's invalid C++. vector is a  
template.

What is interesting is that just replacing the c

Re: Strange problems with EXPAND_AS_DEFINED

Geoff Worboys — 2013-06-10T11:27:22

For the record of this list I thought I should add a follow up.
Dimitri discovered a problem, specific to Windows, associated
with INCLUDE_PATH (part of the preprocessing settings in
doxygen) that can cause doxygen to fail to find some header
files - and so fail to expand macros defined in those headers.

My include path had looked like this:
    ../
or in my original project like this:
    d:/path/project/

The trailing slash was causing an error which is going to be
fixed.  But in the mean time the simple solution is to change
your INCLUDE_PATH to remove the trailing slash.  eg:

To this:
    ..
or this:
    d:/path/project


I hope this helps save some time for someone.

Re: Warning from ":1"

Geoff Worboys — 2013-06-10T11:18:19


The obvious follow on question from this is whether the problem
is specific to templates?  Did you try it with class vector as
a simple class rather than a template?

proj1 (depending on explicit instantiation).  Of course the same
logic should not apply to doxygen, but it would be curious to
know if it might be following that in some way - and the simpler
the example you can report to the bug list the easier it will be
for analysis.

One other thing to check is the quotes around the include.  I
doubt if doxygen treats them differently, but the general rule
(as I understand it) is that external headers would be included
using using:  #include <..proj1/vector.H>

Another interesting question might be what you have for the
INCLUDE_PATH in your doxyfile.  You'll see why I ask that
question in my next post - which you've just reminded me I was
going to make to the list.

Re: Warning from ":1"

Sam Varshavchik — 2013-06-10T10:51:27


I must admit that I haven't, I was guessing. And I thought that it was a  
pretty good guess, but turning inheritance off made no difference, so that  
wasn't it.

However, I have a reproducible test case that demonstrates this, using a  
pair of minimal doxyfiles.

Running doxygen in the proj1 subdirectory creates a tagfile for one header  
file. Then, running doxygen in the proj2 subdirectory issues the strange  
warning for <unknown>:1, referencing the sole method in the header file  
(amidst the verbosity out of the default, loud, Doxyfile):

[mrsam< at >monster proj]$ cat proj1/Doxyfile
FILE_PATTERNS          = *.H
GENERATE_TAGFILE       = tagfile.tag
[mrsam< at >monster proj]$ cat proj1/vector.H
//! Template class

template<typename T>
class vector {

public:

//! Member

void load()
{
}
};

[mrsam< at >monster proj]$ cat proj2/Doxyfile
FILE_PATTERNS          = *.H
TAGFILES               = ../proj1/tagfile.tag=../proj1
[mrsam< at >monster proj]$ cat proj2/user.H
#include "../proj1/vector.H"

//! Derived

class deriv

Re: Strange problems with EXPAND_AS_DEFINED

Geoff Worboys — 2013-06-07T05:40:52

Yippee!!!!!  I finally did it:
https://bugzilla.gnome.org/show_bug.cgi?id=701771

I ended up copying my entire project into a temporary directory
and just kept hacking away at it - testing at each stage - until
I got a simple three file demo.