Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

pcl::io::OpenNI2Grabber is not included in API reference #1864

Open
UnaNancyOwen opened this issue May 3, 2017 · 4 comments
Open

pcl::io::OpenNI2Grabber is not included in API reference #1864

UnaNancyOwen opened this issue May 3, 2017 · 4 comments
Labels
good first issue Skills/areas of expertise needed to tackle the issue kind: todo Type of issue module: io skill: doxygen Skills/areas of expertise needed to tackle the issue

Comments

@UnaNancyOwen
Copy link
Member

⚠️ This is a issue tracker, please use our mailing list for questions: www.pcl-users.org. ⚠️

Your Environment

  • Operating System and version: All OS
  • Compiler: All Compiler
  • PCL Version: 1.8 (and master/HEAD)

Expected Behavior

OpenNI2Grabber should also be included in API reference.

Current Behavior

OpenNIGrabber is included in API reference, but OpenNI2Grabber is not included.

@UnaNancyOwen
Copy link
Member Author

UnaNancyOwen commented May 3, 2017

Possibly, I think the doxygen comment of OpenNI2Grabber is wrong.
Do you have any ideas for resolve this problem?

@UnaNancyOwen
Copy link
Member Author

Other grabbers don't have nested namespace.
But, only OpenNI2Grabber have nested namespace. (I don't know this reason. why?)
I think that this is related to this issue.

  • Other Grabber
namespace pcl
{
  /** \brief Other Grabber
   * \ingroup io
   */
  class PCL_EXPORTS OtherGrabber : public Grabber
  {
  };
}
  • OpenNI2 Grabber
namespace pcl
{
  // insert more doxygen comments in here? or delete this namespace?
  namespace io
  {
    /** \brief OpenNI2 Grabber
     * \ingroup io
     */
    class PCL_EXPORTS OpenNI2Grabber : public Grabber
    {
    };
  }
}

@taketwo
Copy link
Member

taketwo commented Jun 18, 2017

See discussion about the io namespace in #888 and #975.

@kunaltyagi
Copy link
Member

I can confirm that this is still an issue

@kunaltyagi kunaltyagi added kind: todo Type of issue good first issue Skills/areas of expertise needed to tackle the issue module: io skill: doxygen Skills/areas of expertise needed to tackle the issue labels May 19, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Skills/areas of expertise needed to tackle the issue kind: todo Type of issue module: io skill: doxygen Skills/areas of expertise needed to tackle the issue
Projects
None yet
Development

No branches or pull requests

3 participants