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

Missing newline after function prototype/structure member in man pages (Origin: bugzilla #668519) #4549

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.6.1 on platform Other
Assigned to: Dimitri van Heesch

Original attachment names and IDs:

On 2012-01-23 17:12:45 +0000, Gerald Klinkl wrote:

Created attachment 205911
Suggested fix

When generating man pages, the first paragraph of a function description is immediately following the function prototype rather than being separated be a newline. Same for structure members.

== snip ==
.SH "Function Documentation"
.PP
.SS "configParams_t* \fBinitWaveReaderAPI\fP (const char *configFile, const char *appName)"The \fBinitWaveReaderAPI()\fP function initializes the waveform reader API&. \fBinitWaveReaderAPI()\fP takes configFile, the name and path of the configuration file and appName, the name of the application used for error messages&.
.PP
== end snip ==
== snip ==
.SH "Field Documentation"
.PP
.SS "size_t \fBwaveDataResponse_t::wfa_bytesRead\fP"number of bytes read (only CSF)
== end snip ==

On 2012-02-18 13:32:52 +0000, Dimitri van Heesch wrote:

Thanks, I'll include the patch in the next subversion update.

On 2012-02-25 15:37:14 +0000, Dimitri van Heesch wrote:

This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.8.0. 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.

@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