touch-packages team mailing list archive

[Michi Henning <michi.henning@xxxxxxxxxxxxx>]

** Changed in: unity-scopes-api (Ubuntu)
       Status: New => Fix Released

-- 
You received this bug notification because you are a member of Ubuntu
Touch seeded packages, which is subscribed to unity-scopes-api in
Ubuntu.
https://bugs.launchpad.net/bugs/1284935

Title:
  Redundant doxygen comments

Status in API for Unity scopes integration:
  Fix Released
Status in “unity-scopes-api” package in Ubuntu:
  Fix Released

Bug description:
  With the recent change to abstract bases for everythign in the public
  API, we have ended up with tons of replicated doxygen comments. For an
  example, check Registry.h and RegistryBase.h.

  I'm concerned that this will create a documenation maintenance
  problem. I'm not sure how to best solve this at the moment.

  It appears impossible to tell doxygen to show the members of a class,
  but to not complain about undocumented methods:

  http://stackoverflow.com/questions/16993250/suppress-doxygen-warning-
  for-undocumented-member-function-but-leave-synopsis-in

  Anyone with a suggestion? I'd rather not have to have identical
  documentation for each of the bases and its derived classes, having to
  remember to update everything multiple times when we make a change.

To manage notifications about this bug go to:
https://bugs.launchpad.net/unity-scopes-api/+bug/1284935/+subscriptions