Skip to content

Commit a8a0d80

Browse files
committed
Add Doxygen file tags to all headers except Defines.h.
1 parent eeac260 commit a8a0d80

File tree

6 files changed

+31
-0
lines changed

6 files changed

+31
-0
lines changed

source/pdal/capi/DimType.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@
77

88
#include "Forward.h"
99

10+
/**
11+
* @file DimType.h
12+
* Functions to inspect dimension types.
13+
*/
14+
1015
#ifdef __cplusplus
1116

1217
namespace pdal

source/pdal/capi/Forward.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,11 @@
1515
#define PDAL_C_API PDAL_C_IMPORT_API
1616
#endif
1717

18+
/**
19+
* @file Forward.h
20+
* Forward declarations for the PDAL C API.
21+
*/
22+
1823
#ifdef __cplusplus
1924
#include <memory>
2025
#include <set>

source/pdal/capi/Pipeline.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@
66

77
#include "Forward.h"
88

9+
/**
10+
* @file Pipeline.h
11+
* Functions to launch and inspect the results of a pipeline.
12+
*/
13+
914
#ifdef __cplusplus
1015

1116
namespace pdal

source/pdal/capi/PointLayout.h

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,12 @@
77

88
#include "Forward.h"
99

10+
/**
11+
* @file PointLayout.h
12+
* Functions to inspect the contents of a point layout.
13+
*/
14+
15+
1016
#ifdef __cplusplus
1117
namespace pdal
1218
{

source/pdal/capi/PointView.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@
66

77
#include "Forward.h"
88

9+
/**
10+
* @file PointView.h
11+
* Functions to inspect the contents of a point view.
12+
*/
13+
914
#ifdef __cplusplus /* __cplusplus */
1015

1116
namespace pdal

source/pdal/capi/PointViewIterator.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@
66

77
#include "Forward.h"
88

9+
/**
10+
* @file PointViewIterator.h
11+
* Functions to inspect the contents of a point view iterator.
12+
*/
13+
914
#ifdef __cplusplus
1015
#include <pdal/PointView.hpp>
1116

0 commit comments

Comments
 (0)