function get_options cannot be documented

Bug #1285798 reported by Kevin O'Gorman
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
doxygen (Ubuntu)
New
Undecided
Unassigned

Bug Description

My C program had a function get_options(int, char**), and doxygen warned that it was not documented no matter what I tried. It was the only one of about 30 functions with this complaint.

Finally, I changed its name to getOptions without making any other changes, and the warning went away.

There's no obvious reason or rationale for this name to be different from all other names.

ProblemType: Bug
DistroRelease: Ubuntu 13.10
Package: doxygen 1.8.4-1
ProcVersionSignature: Ubuntu 3.11.0-17.31-generic 3.11.10.3
Uname: Linux 3.11.0-17-generic x86_64
NonfreeKernelModules: nvidia
ApportVersion: 2.12.5-0ubuntu2.2
Architecture: amd64
Date: Thu Feb 27 09:43:15 2014
InstallationDate: Installed on 2013-12-25 (64 days ago)
InstallationMedia: Xubuntu 13.10 "Saucy Salamander" - Release amd64 (20131016)
MarkForUpload: True
SourcePackage: doxygen
UpgradeStatus: No upgrade log present (probably fresh install)

Revision history for this message
Kevin O'Gorman (kogorman-pacbell) wrote :
Revision history for this message
Kevin O'Gorman (kogorman-pacbell) wrote :

The bug occurred in sourceforge project 'qubic' in versions before 0.5.8.
In particular see git commit 39ebfdc9cf41f1e71c0528140f92711ee5d95678 which is just before the fix, and compare it to commit 540bdc905e407ccf7de3f497ab21aaf00e25260f which is just after.

Revision history for this message
paolog (paolo-greppi) wrote :

Unreproducible with doxygen 1.9.1 on debian 11 (bullseye).

I did:

git clone https://git.code.sf.net/p/qubic/git qubic-git
cd qubic-git
git checkout 540bdc905e407ccf7de3f497ab21aaf00e25260f
doxygen
mv doc doc_fix
git checkout 39ebfdc9cf41f1e71c0528140f92711ee5d95678
doxygen # no warning is issued here

If I search for get_options in doc/html/index.html it's there, as is getOptions in doc_fix/html/index.html.
I attach screenshots

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.