Skip to content
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

Todo stops at first sentence. (Origin: bugzilla #172256) #1535

Closed
doxygen opened this issue Jul 1, 2018 · 3 comments
Closed

Todo stops at first sentence. (Origin: bugzilla #172256) #1535

doxygen opened this issue Jul 1, 2018 · 3 comments
Labels

Comments

@doxygen
Copy link
Owner

doxygen commented Jul 1, 2018

status NEW severity normal in component general for ---
Reported in version 1.4.x on platform Other
Assigned to: Dimitri van Heesch

Original attachment names and IDs:

On 2005-03-31 14:07:40 +0000, David Parsons wrote:

Version details: 1.4.2
Distribution/Version: XP SP2

Documentation says 

\todo { paragraph describing what is to be done }

but V1.4.2 with JAVADOC_AUTOBRIEF on writes only the first sentence as part
of
the todo list and treats the rest as a separate comment in the general class
description. It omits it entirely on the Todo list page. V1.3.9 behaved as 
documented - always included the full paragraph.

Example
/// @todo Item1. More text.
/// @todo Item2. More text 2.
class ...

Produces (in class description)
Todo: Item1.

      Item2.

More text. More text 2. [In the same paragraph.]

On 2005-06-17 11:44:37 +0000, Martin Krogmann wrote:

I have a similar bug. When I have two Doxygen comments for one function, for
example one long comment in the header file and a @todo in the source file,
then
only the first sentence of the long comment is printed in the header file
documentation. This bug also occures if I remove the @todo flag and put
another
normal /** hallo welt */ comment in the source file within the function.

On 2013-08-25 08:48:27 +0000, albert wrote:

Created attachment 253049
example of second reported problem

I tested the original problem with version 1.4.2 and could reproduce the the
problem. With version 1.3.9 it was not present. It depends on
JAVADOC_AUTOBRIEF = YES.
In version 1.8.5 it is not present either.

I think this problem has been solved in the mean time


The second problem as submitted by Martin Krogmann is in my opinion in 1.8.5
still present. It is independent of the setting of JAVADOC_AUTOBRIEF.
When we look in the attached example th the results for cc / tst_c we see
that the detailed description is completely gone. When looking at bb /tst we
see that the information is present.
@albert-github
Copy link
Collaborator

I've just pushed a proposed patch, pull request #8671

@albert-github albert-github added the fixed but not released Bug is fixed in github, but still needs to make its way to an official release label Aug 10, 2021
@albert-github
Copy link
Collaborator

Code has been integrated in master on GitHub (please don't close the issue as this will be done at the moment of an official release).

@doxygen
Copy link
Owner Author

doxygen commented Aug 18, 2021

This issue was previously marked 'fixed but not released',
which means it should be fixed in doxygen version 1.9.2.
Please verify if this is indeed the case. Reopen the
issue if you think it is not fixed and please include any additional information
that you think can be relevant (preferably in the form of a self-contained example).

@doxygen doxygen removed the fixed but not released Bug is fixed in github, but still needs to make its way to an official release label Aug 18, 2021
@doxygen doxygen closed this as completed Aug 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants