PointCloudLibrary/pcl

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

Open

#1,864 opened on May 3, 2017

View on GitHub
 (4 comments) (1 reaction) (0 assignees)C++ (9,023 stars) (4,506 forks)batch import
good first issuekind: todomodule: ioskill: doxygen

Description

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

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.

Contributor guide

Tech stack
cpp
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic C++Doxygen basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Locate the header file for pcl::io::OpenNI2Grabber (likely in pcl/io/openni2 grabber.h) and ensure it contains Doxygen comments for the class. Then check the Doxygen configuration in the repository (e.g., CMakeLists.txt or Doxyfile) to see if the file is included in the input. The issue may require adding the file to the documentation build or fixing existing comments. There are no linked PRs, so focus on the source and configuration files.