Project

General

Profile

Bug #6115

doc: asphyxiate does not support class

Added by Loic Dachary about 6 years ago. Updated over 4 years ago.

Status:
Resolved
Priority:
Normal
Assignee:
Category:
OSD
Target version:
-
Start date:
08/24/2013
Due date:
% Done:

100%

Source:
other
Tags:
Backport:
Regression:
No
Severity:
3 - minor
Reviewed:
Affected Versions:
ceph-qa-suite:
Pull request ID:

Description

asphyxiate is unable to handle classes which makes it impossible to integrate C++ class documentation as part of a .rst file.

  File "ceph/build-doc/virtualenv/src/asphyxiate/asphyxiate/__init__.py", line 388, in render_compounddef
    "cannot handle {node.tag} kind={node.attrib[kind]}".format(node=node)
AssertionError: cannot handle compounddef kind=class


Related issues

Duplicated by Ceph - Bug #11077: Can't build documentation on Ubuntu 14.04 and likely other releases Duplicate 03/10/2015

Associated revisions

Revision cd69ded7 (diff)
Added by Kefu Chai over 4 years ago

doc: Switch doxygen integration back to breathe

  • asphyxiate needs more toolings, see
    https://github.com/ceph/asphyxiate/issues/1
  • this commit basically reverts c96064
  • use `autodoxygen` directive to doxygen referenced source files
  • do not call `doxygen` explicitly in `build-doc`, `autodoxygen`
    will take care of it.

Fixes: #6115
Fixes: #6115
Signed-off-by: Kefu Chai <>

History

#1 Updated by Dan Mick about 6 years ago

  • Subject changed from doc: asphyxiate does support class to doc: asphyxiate does not support class

#2 Updated by David Zafman about 5 years ago

It would be nice if we could create documentation based on the librados namespace. Doxygen comments would be in 2 files src/include/rados/rados_types.hpp and src/include/rados/librados.hpp. The namespace would cover the main classes in librados.hpp, and some constants / related structs.

#3 Updated by Kefu Chai over 4 years ago

  • Status changed from New to Resolved
  • Assignee set to Kefu Chai
  • % Done changed from 0 to 100

Also available in: Atom PDF