[Bug 1285798] [NEW] function get_options cannot be documented

Kevin O'Gorman kogorman at gmail.com
Thu Feb 27 17:48:44 UTC 2014


Public bug reported:

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)

** Affects: doxygen (Ubuntu)
     Importance: Undecided
         Status: New


** Tags: amd64 apport-bug saucy

-- 
You received this bug notification because you are a member of Ubuntu
Foundations Bugs, which is subscribed to doxygen in Ubuntu.
https://bugs.launchpad.net/bugs/1285798

Title:
  function get_options cannot be documented

Status in “doxygen” package in Ubuntu:
  New

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)

To manage notifications about this bug go to:
https://bugs.launchpad.net/ubuntu/+source/doxygen/+bug/1285798/+subscriptions



More information about the foundations-bugs mailing list