PointCloudLibrary/pcl

Ensure no `*.hpp` files are needed to be included by the user, only the `*.h` should be required

Open

#3,245 opened on Jul 18, 2019

View on GitHub
 (5 comments) (0 reactions) (0 assignees)C++ (4,506 forks)batch import
good first issuekind: todo

Repository metrics

Stars
 (9,023 stars)
PR merge metrics
 (Avg merge 8d 7h) (3 merged PRs in 30d)

Description

Your Environment

  • Operating System and version: Win10
  • Compiler:
  • PCL Version: 1.9.1

Context

In general, we can find PCL .hpp are included at end of header file

#ifdef PCL_NO_PRECOMPILE
#include <pcl/....hpp>
#endif

But why some .hpp are not. For example: pcl/surface/impl/grid_projection.hpp: it is included in .cpp pcl/outofcore/impl/octree_base.hpp: it need to be included by user self

Expected Behavior

Current Behavior

Code to Reproduce

Possible Solution

Contributor guide

Research direction
Identify all .hpp files in the PCL source that are not included in the corresponding .h file with the proper #ifdef PCL NO PRECOMPILE guard, and add the include line. For example, pcl/surface/impl/grid projection.hpp is included only in .cpp and pcl/outofcore/impl/octree base.hpp requires manual inclusion by the user. Ensure such files are included in their .h counterpart.
Tech stack
cpp
Domain
build system
Issue type
Refactor
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.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C++Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60