New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation marker sequence //!< no longer works (Origin: bugzilla #621805) #3807

Closed
doxygen opened this Issue Jul 2, 2018 · 0 comments

Comments

Projects
None yet
1 participant
@doxygen
Owner

doxygen commented Jul 2, 2018

status RESOLVED severity normal in component general for ---
Reported in version 1.7.0 on platform Other
Assigned to: Dimitri van Heesch

Original attachment names and IDs:

On 2010-06-16 16:56:15 +0000, Bernd Giesen wrote:

Created attachment 163851
The source/header file containing the related part to be documented

As of doxygen v1.7.0 the documentation marker sequence //!< seems no longer to be accepted for documenation after members as described in the doxygen docs. Without changing anything in my source code files running doxygen v1.6.3 on them succeeded whereas running doxygen v1.7.0 failed with following message lines in the warning log file:

C:/Projects/Profile.h:24: Warning: Member CBP_LOAD_PROFILE (define) of group defCallBackParams is not documented.
C:/Projects/Profile.h:23: Warning: Member CBP_SAVE_PROFILE (define) of group defCallBackParams is not documented.

This behaviour is reproducable. v1.6.3 works, v1.7.0 doesn't.

See the attached Profile.h file for the related source code part causing the above mentioned warnings.

Moreover, you should notice, that for the "#define CBP_UNDEFINED" line no warning is generated even it is documented the same way. However, no final documention is created as well.

On 2010-06-16 16:57:05 +0000, Bernd Giesen wrote:

Created attachment 163852
The extracted doxygen warning messages

On 2010-06-16 17:01:24 +0000, Bernd Giesen wrote:

FYI: Selected target output type is HTML.

On 2010-06-17 09:25:04 +0000, Dimitri van Heesch wrote:

Confirmed. Should be fixed in the next update.

On 2010-06-25 11:48:59 +0000, Dimitri van Heesch wrote:

This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.7.1. Please verify if this is indeed the case. Reopen the
bug if you think it is not fixed and please include any additional information
that you think can be relevant.

On 2010-08-14 18:56:31 +0000, Tim Niemueller wrote:

I'm still seeing this bug with Doxygen 1.7.1 and the /**< notation. System is Fedora 13 on x86_64.

On 2010-08-14 18:57:47 +0000, Tim Niemueller wrote:

But I'm seeing this for something like
typedef struct {
int value; /**< documentation
} some_struct_t.

On 2010-08-14 18:58:46 +0000, Tim Niemueller wrote:

Sorry, have to extend the comment again, the documentation block is terminated, so it is:
typedef struct {
int value; /**< documentation */
} some_struct_t.

On 2010-08-14 19:06:54 +0000, Dimitri van Heesch wrote:

Tim, can you please attach a self-contained example (source+config file in a tar or zip) that allows me to reproduce the problem?

Since there are known issues using the 32bit version of doxygen on 64bit systems, please also mention if you use the i386 binary provided by me, the one provided by Fedora, or if you built it yourself.

On 2010-08-14 19:15:59 +0000, Tim Niemueller wrote:

I use the binary provided by Fedora. The code is available like this:

git clone git://git.fawkesrobotics.org/fawkes.git
cd fawkes
make check

The last command calls doxygen and will generate a file warnings.txt with the documentation errors. With 1.6.2 this produces no warnings. I think I've spotted some things that are correct errors (missing @return statements not detected in the old version), but the vast majority of the messages should be false, in combination with bug # 625531.

Since we use Doxygen to enforce complete documentation this is particularly painful to us and a fast release after a fix would be appreciated! Thanks for your help!

On 2010-10-31 18:54:11 +0000, Tim Niemueller wrote:

Seems to be fixed in 1.7.2.

On 2010-10-31 19:51:58 +0000, Dimitri van Heesch wrote:

Closing the bug. If you still see other appearances with version 1.7.2, please reopen and provide additional information.

@doxygen doxygen closed this Jul 2, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment