Skip to content

Doxygen fails to discover some methods of given struct #392

@wprzytula

Description

@wprzytula

Problem

Consider CassDataType. Only part of methods on that type are shown in the generated docs. Examples of missing functions include cass_data_type_type and cass_data_type_is_frozen.

Cause

Doxygen apparently fails to parse const CassDataType* as a parameter of type CassDataType, therefore the function is not associated with that type in the docs. At the same time, Doxygen correctly discovers CassDataType* and CassDataType const* - the problem is about const preceding the type name.

Solution

ChatGPT offered two viable solutions:

  1. (preferred) add \memberof CassDataType to all methods on CassDataType. The same for all methods of all structs.
  2. Always write T const* instead of const T*.

As the 1. solution seems more robust, I'd go with it.

Metadata

Metadata

Assignees

Labels

P1P1 priority item - very importantbugSomething isn't workingdocumentationImprovements or additions to documentation

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions