Project

General

Profile

Actions

Bug #6115

closed

doc: asphyxiate does not support class

Added by Loïc Dachary over 10 years ago. Updated about 9 years ago.

Status:
Resolved
Priority:
Normal
Assignee:
Category:
OSD
Target version:
-
% Done:

100%

Source:
other
Tags:
Backport:
Regression:
Severity:
3 - minor
Reviewed:
Affected Versions:
ceph-qa-suite:
Pull request ID:
Crash signature (v1):
Crash signature (v2):

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 1 (0 open1 closed)

Has duplicate Ceph - Bug #11077: Can't build documentation on Ubuntu 14.04 and likely other releasesDuplicateKefu Chai03/10/2015

Actions
Actions #1

Updated by Dan Mick over 10 years ago

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

Updated by David Zafman over 9 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.

Actions #3

Updated by Kefu Chai about 9 years ago

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

Also available in: Atom PDF