Skip to content

[Doc][C++]: Refine documentation comments #203

Closed
@Thespica

Description

Is there an existing issue for this?

  • I have searched the existing issues

Current Behavior

In documentation comments, @param name is not same as real parameter name.
Here are some differences I had discovered, maybe there are others I haven't discovered :

https://github.com/alibaba/GraphAr/blob/75dfb4234c7bb1aaaf2d408a4e3e0aed92a127a6/cpp/include/gar/graph_info.h#L1086
https://github.com/alibaba/GraphAr/blob/75dfb4234c7bb1aaaf2d408a4e3e0aed92a127a6/cpp/include/gar/graph_info.h#L1260

Expected Behavior

@param name is same as real parameter name.

Minimal Reproducible Example

https://github.com/alibaba/GraphAr/blob/75dfb4234c7bb1aaaf2d408a4e3e0aed92a127a6/cpp/include/gar/graph_info.h#L1257
https://github.com/alibaba/GraphAr/blob/75dfb4234c7bb1aaaf2d408a4e3e0aed92a127a6/cpp/include/gar/graph_info.h#L1260

Environment

  • Operating system:
  • GraphAr version:

Link to GraphAr Logs

No response

Further Information

No response

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions