Skip to content

Commit 38c842c

Browse files
peter-urbanpeter-urban
committed
update documentation
1 parent c54c6d0 commit 38c842c

File tree

4 files changed

+97
-85
lines changed

4 files changed

+97
-85
lines changed

‎src/nanomodule/new_doc_header.hpp‎

Lines changed: 23 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -8,25 +8,28 @@
88
#pragma once
99

1010
#ifndef __DOCSTRINGS_HPP__
11+
#define __DOCSTRINGS_HPP__
1112

12-
#define __EXPAND(x) x
13-
#define __COUNT(_1, _2, _3, _4, _5, _6, _7, _8, _9, _10, COUNT, ...) COUNT
14-
#define __VA_SIZE(...) __EXPAND(__COUNT(__VA_ARGS__, 10, 9, 8, 7, 6, 5, 4, 3, 2, 1))
15-
#define __CAT1(a, b) a##b
16-
#define __CAT2(a, b) __CAT1(a, b)
17-
#define __DOC1(n1) __doc_##n1
18-
#define __DOC2(n1, n2) __doc_##n1##_##n2
19-
#define __DOC3(n1, n2, n3) __doc_##n1##_##n2##_##n3
20-
#define __DOC4(n1, n2, n3, n4) __doc_##n1##_##n2##_##n3##_##n4
21-
#define __DOC5(n1, n2, n3, n4, n5) __doc_##n1##_##n2##_##n3##_##n4##_##n5
22-
#define __DOC6(n1, n2, n3, n4, n5, n6) __doc_##n1##_##n2##_##n3##_##n4##_##n5##_##n6
23-
#define __DOC7(n1, n2, n3, n4, n5, n6, n7) __doc_##n1##_##n2##_##n3##_##n4##_##n5##_##n6##_##n7
24-
#define __DOC8(n1, n2, n3, n4, n5, n6, n7, n8) \
25-
__doc_##n1##_##n2##_##n3##_##n4##_##n5##_##n6##_##n7##_##n8
26-
#define __DOC9(n1, n2, n3, n4, n5, n6, n7, n8, n9) \
27-
__doc_##n1##_##n2##_##n3##_##n4##_##n5##_##n6##_##n7##_##n8##_##n9
28-
#define __DOC10(n1, n2, n3, n4, n5, n6, n7, n8, n9, n10) \
29-
__doc_##n1##_##n2##_##n3##_##n4##_##n5##_##n6##_##n7##_##n8##_##n9##_##n10
30-
#define DOC(...) __EXPAND(__EXPAND(__CAT2(__DOC, __VA_SIZE(__VA_ARGS__)))(__VA_ARGS__))
13+
#define MKD_EXPAND(x) x
14+
#define MKD_COUNT(_1, _2, _3, _4, _5, _6, _7, _8, _9, _10, COUNT, ...) COUNT
15+
#define MKD_VA_SIZE(...) MKD_EXPAND(MKD_COUNT(__VA_ARGS__, 10, 9, 8, 7, 6, 5, 4, 3, 2, 1, 0))
16+
#define MKD_CAT1(a, b) a ## b
17+
#define MKD_CAT2(a, b) MKD_CAT1(a, b)
18+
#define MKD_DOC1(n1) mkd_doc_##n1
19+
#define MKD_DOC2(n1, n2) mkd_doc_##n1##_##n2
20+
#define MKD_DOC3(n1, n2, n3) mkd_doc_##n1##_##n2##_##n3
21+
#define MKD_DOC4(n1, n2, n3, n4) mkd_doc_##n1##_##n2##_##n3##_##n4
22+
#define MKD_DOC5(n1, n2, n3, n4, n5) mkd_doc_##n1##_##n2##_##n3##_##n4##_##n5
23+
#define MKD_DOC6(n1, n2, n3, n4, n5, n6) mkd_doc_##n1##_##n2##_##n3##_##n4##_##n5##_##n6
24+
#define MKD_DOC7(n1, n2, n3, n4, n5, n6, n7) mkd_doc_##n1##_##n2##_##n3##_##n4##_##n5##_##n6##_##n7
25+
#define MKD_DOC8(n1, n2, n3, n4, n5, n6, n7, n8) mkd_doc_##n1##_##n2##_##n3##_##n4##_##n5##_##n6##_##n7##_##n8
26+
#define MKD_DOC9(n1, n2, n3, n4, n5, n6, n7, n8, n9) mkd_doc_##n1##_##n2##_##n3##_##n4##_##n5##_##n6##_##n7##_##n8##_##n9
27+
#define MKD_DOC10(n1, n2, n3, n4, n5, n6, n7, n8, n9, n10) mkd_doc_##n1##_##n2##_##n3##_##n4##_##n5##_##n6##_##n7##_##n8##_##n9##_##n10
28+
#define DOC(...) MKD_EXPAND(MKD_EXPAND(MKD_CAT2(MKD_DOC, MKD_VA_SIZE(__VA_ARGS__)))(__VA_ARGS__))
3129

32-
#endif // NEW_DOC_HEADER_HPP
30+
#if defined(__GNUG__)
31+
#pragma GCC diagnostic push
32+
#pragma GCC diagnostic ignored "-Wunused-variable"
33+
#endif
34+
35+
#endif // __DOCSTRINGS_HPP__

‎src/pymodule/new_doc_header.hpp‎

Lines changed: 23 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -8,25 +8,28 @@
88
#pragma once
99

1010
#ifndef __DOCSTRINGS_HPP__
11+
#define __DOCSTRINGS_HPP__
1112

12-
#define __EXPAND(x) x
13-
#define __COUNT(_1, _2, _3, _4, _5, _6, _7, _8, _9, _10, COUNT, ...) COUNT
14-
#define __VA_SIZE(...) __EXPAND(__COUNT(__VA_ARGS__, 10, 9, 8, 7, 6, 5, 4, 3, 2, 1))
15-
#define __CAT1(a, b) a##b
16-
#define __CAT2(a, b) __CAT1(a, b)
17-
#define __DOC1(n1) __doc_##n1
18-
#define __DOC2(n1, n2) __doc_##n1##_##n2
19-
#define __DOC3(n1, n2, n3) __doc_##n1##_##n2##_##n3
20-
#define __DOC4(n1, n2, n3, n4) __doc_##n1##_##n2##_##n3##_##n4
21-
#define __DOC5(n1, n2, n3, n4, n5) __doc_##n1##_##n2##_##n3##_##n4##_##n5
22-
#define __DOC6(n1, n2, n3, n4, n5, n6) __doc_##n1##_##n2##_##n3##_##n4##_##n5##_##n6
23-
#define __DOC7(n1, n2, n3, n4, n5, n6, n7) __doc_##n1##_##n2##_##n3##_##n4##_##n5##_##n6##_##n7
24-
#define __DOC8(n1, n2, n3, n4, n5, n6, n7, n8) \
25-
__doc_##n1##_##n2##_##n3##_##n4##_##n5##_##n6##_##n7##_##n8
26-
#define __DOC9(n1, n2, n3, n4, n5, n6, n7, n8, n9) \
27-
__doc_##n1##_##n2##_##n3##_##n4##_##n5##_##n6##_##n7##_##n8##_##n9
28-
#define __DOC10(n1, n2, n3, n4, n5, n6, n7, n8, n9, n10) \
29-
__doc_##n1##_##n2##_##n3##_##n4##_##n5##_##n6##_##n7##_##n8##_##n9##_##n10
30-
#define DOC(...) __EXPAND(__EXPAND(__CAT2(__DOC, __VA_SIZE(__VA_ARGS__)))(__VA_ARGS__))
13+
#define MKD_EXPAND(x) x
14+
#define MKD_COUNT(_1, _2, _3, _4, _5, _6, _7, _8, _9, _10, COUNT, ...) COUNT
15+
#define MKD_VA_SIZE(...) MKD_EXPAND(MKD_COUNT(__VA_ARGS__, 10, 9, 8, 7, 6, 5, 4, 3, 2, 1, 0))
16+
#define MKD_CAT1(a, b) a ## b
17+
#define MKD_CAT2(a, b) MKD_CAT1(a, b)
18+
#define MKD_DOC1(n1) mkd_doc_##n1
19+
#define MKD_DOC2(n1, n2) mkd_doc_##n1##_##n2
20+
#define MKD_DOC3(n1, n2, n3) mkd_doc_##n1##_##n2##_##n3
21+
#define MKD_DOC4(n1, n2, n3, n4) mkd_doc_##n1##_##n2##_##n3##_##n4
22+
#define MKD_DOC5(n1, n2, n3, n4, n5) mkd_doc_##n1##_##n2##_##n3##_##n4##_##n5
23+
#define MKD_DOC6(n1, n2, n3, n4, n5, n6) mkd_doc_##n1##_##n2##_##n3##_##n4##_##n5##_##n6
24+
#define MKD_DOC7(n1, n2, n3, n4, n5, n6, n7) mkd_doc_##n1##_##n2##_##n3##_##n4##_##n5##_##n6##_##n7
25+
#define MKD_DOC8(n1, n2, n3, n4, n5, n6, n7, n8) mkd_doc_##n1##_##n2##_##n3##_##n4##_##n5##_##n6##_##n7##_##n8
26+
#define MKD_DOC9(n1, n2, n3, n4, n5, n6, n7, n8, n9) mkd_doc_##n1##_##n2##_##n3##_##n4##_##n5##_##n6##_##n7##_##n8##_##n9
27+
#define MKD_DOC10(n1, n2, n3, n4, n5, n6, n7, n8, n9, n10) mkd_doc_##n1##_##n2##_##n3##_##n4##_##n5##_##n6##_##n7##_##n8##_##n9##_##n10
28+
#define DOC(...) MKD_EXPAND(MKD_EXPAND(MKD_CAT2(MKD_DOC, MKD_VA_SIZE(__VA_ARGS__)))(__VA_ARGS__))
3129

32-
#endif // NEW_DOC_HEADER_HPP
30+
#if defined(__GNUG__)
31+
#pragma GCC diagnostic push
32+
#pragma GCC diagnostic ignored "-Wunused-variable"
33+
#endif
34+
35+
#endif // __DOCSTRINGS_HPP__

‎src/themachinethatgoesping/pingprocessing/watercolumn/echograms/.docstrings/echogrambase.doc.hpp‎

Lines changed: 26 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -10,42 +10,45 @@
1010
#pragma once
1111

1212
#ifndef __DOCSTRINGS_HPP__
13+
#define __DOCSTRINGS_HPP__
14+
15+
#define MKD_EXPAND(x) x
16+
#define MKD_COUNT(_1, _2, _3, _4, _5, _6, _7, _8, _9, _10, COUNT, ...) COUNT
17+
#define MKD_VA_SIZE(...) MKD_EXPAND(MKD_COUNT(__VA_ARGS__, 10, 9, 8, 7, 6, 5, 4, 3, 2, 1, 0))
18+
#define MKD_CAT1(a, b) a ## b
19+
#define MKD_CAT2(a, b) MKD_CAT1(a, b)
20+
#define MKD_DOC1(n1) mkd_doc_##n1
21+
#define MKD_DOC2(n1, n2) mkd_doc_##n1##_##n2
22+
#define MKD_DOC3(n1, n2, n3) mkd_doc_##n1##_##n2##_##n3
23+
#define MKD_DOC4(n1, n2, n3, n4) mkd_doc_##n1##_##n2##_##n3##_##n4
24+
#define MKD_DOC5(n1, n2, n3, n4, n5) mkd_doc_##n1##_##n2##_##n3##_##n4##_##n5
25+
#define MKD_DOC6(n1, n2, n3, n4, n5, n6) mkd_doc_##n1##_##n2##_##n3##_##n4##_##n5##_##n6
26+
#define MKD_DOC7(n1, n2, n3, n4, n5, n6, n7) mkd_doc_##n1##_##n2##_##n3##_##n4##_##n5##_##n6##_##n7
27+
#define MKD_DOC8(n1, n2, n3, n4, n5, n6, n7, n8) mkd_doc_##n1##_##n2##_##n3##_##n4##_##n5##_##n6##_##n7##_##n8
28+
#define MKD_DOC9(n1, n2, n3, n4, n5, n6, n7, n8, n9) mkd_doc_##n1##_##n2##_##n3##_##n4##_##n5##_##n6##_##n7##_##n8##_##n9
29+
#define MKD_DOC10(n1, n2, n3, n4, n5, n6, n7, n8, n9, n10) mkd_doc_##n1##_##n2##_##n3##_##n4##_##n5##_##n6##_##n7##_##n8##_##n9##_##n10
30+
#define DOC(...) MKD_EXPAND(MKD_EXPAND(MKD_CAT2(MKD_DOC, MKD_VA_SIZE(__VA_ARGS__)))(__VA_ARGS__))
1331

14-
#define __EXPAND(x) x
15-
#define __COUNT(_1, _2, _3, _4, _5, _6, _7, _8, _9, _10, COUNT, ...) COUNT
16-
#define __VA_SIZE(...) __EXPAND(__COUNT(__VA_ARGS__, 10, 9, 8, 7, 6, 5, 4, 3, 2, 1))
17-
#define __CAT1(a, b) a##b
18-
#define __CAT2(a, b) __CAT1(a, b)
19-
#define __DOC1(n1) __doc_##n1
20-
#define __DOC2(n1, n2) __doc_##n1##_##n2
21-
#define __DOC3(n1, n2, n3) __doc_##n1##_##n2##_##n3
22-
#define __DOC4(n1, n2, n3, n4) __doc_##n1##_##n2##_##n3##_##n4
23-
#define __DOC5(n1, n2, n3, n4, n5) __doc_##n1##_##n2##_##n3##_##n4##_##n5
24-
#define __DOC6(n1, n2, n3, n4, n5, n6) __doc_##n1##_##n2##_##n3##_##n4##_##n5##_##n6
25-
#define __DOC7(n1, n2, n3, n4, n5, n6, n7) __doc_##n1##_##n2##_##n3##_##n4##_##n5##_##n6##_##n7
26-
#define __DOC8(n1, n2, n3, n4, n5, n6, n7, n8) \
27-
__doc_##n1##_##n2##_##n3##_##n4##_##n5##_##n6##_##n7##_##n8
28-
#define __DOC9(n1, n2, n3, n4, n5, n6, n7, n8, n9) \
29-
__doc_##n1##_##n2##_##n3##_##n4##_##n5##_##n6##_##n7##_##n8##_##n9
30-
#define __DOC10(n1, n2, n3, n4, n5, n6, n7, n8, n9, n10) \
31-
__doc_##n1##_##n2##_##n3##_##n4##_##n5##_##n6##_##n7##_##n8##_##n9##_##n10
32-
#define DOC(...) __EXPAND(__EXPAND(__CAT2(__DOC, __VA_SIZE(__VA_ARGS__)))(__VA_ARGS__))
33-
34-
#endif // NEW_DOC_HEADER_HPP
32+
#if defined(__GNUG__)
33+
#pragma GCC diagnostic push
34+
#pragma GCC diagnostic ignored "-Wunused-variable"
35+
#endif
36+
37+
#endif // __DOCSTRINGS_HPP__
3538
#if defined(__GNUG__)
3639
#pragma GCC diagnostic push
3740
#pragma GCC diagnostic ignored "-Wunused-variable"
3841
#endif
3942

4043

41-
static const char *__doc_themachinethatgoesping_pingprocessing_watercolumn_echograms_EchogramBase =
44+
static const char *mkd_doc_themachinethatgoesping_pingprocessing_watercolumn_echograms_EchogramBase =
4245
R"doc(Class to convert 2d water column ping coordinates to 2d echogram
4346
images Allows for converting between ping_nr/sample_nr to
4447
time/depth/range and vice versa Allows for adding parameters in
4548
different units (e.g. time, depth, range) and convert them to echogram
4649
coordinates)doc";
4750

48-
static const char *__doc_themachinethatgoesping_pingprocessing_watercolumn_echograms_EchogramBase_EchogramBase = R"doc()doc";
51+
static const char *mkd_doc_themachinethatgoesping_pingprocessing_watercolumn_echograms_EchogramBase_EchogramBase = R"doc()doc";
4952

5053
#if defined(__GNUG__)
5154
#pragma GCC diagnostic pop

‎src/themachinethatgoesping/pingprocessing/watercolumn/image/.docstrings/make_wci.doc.hpp‎

Lines changed: 25 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -10,35 +10,38 @@
1010
#pragma once
1111

1212
#ifndef __DOCSTRINGS_HPP__
13+
#define __DOCSTRINGS_HPP__
14+
15+
#define MKD_EXPAND(x) x
16+
#define MKD_COUNT(_1, _2, _3, _4, _5, _6, _7, _8, _9, _10, COUNT, ...) COUNT
17+
#define MKD_VA_SIZE(...) MKD_EXPAND(MKD_COUNT(__VA_ARGS__, 10, 9, 8, 7, 6, 5, 4, 3, 2, 1, 0))
18+
#define MKD_CAT1(a, b) a ## b
19+
#define MKD_CAT2(a, b) MKD_CAT1(a, b)
20+
#define MKD_DOC1(n1) mkd_doc_##n1
21+
#define MKD_DOC2(n1, n2) mkd_doc_##n1##_##n2
22+
#define MKD_DOC3(n1, n2, n3) mkd_doc_##n1##_##n2##_##n3
23+
#define MKD_DOC4(n1, n2, n3, n4) mkd_doc_##n1##_##n2##_##n3##_##n4
24+
#define MKD_DOC5(n1, n2, n3, n4, n5) mkd_doc_##n1##_##n2##_##n3##_##n4##_##n5
25+
#define MKD_DOC6(n1, n2, n3, n4, n5, n6) mkd_doc_##n1##_##n2##_##n3##_##n4##_##n5##_##n6
26+
#define MKD_DOC7(n1, n2, n3, n4, n5, n6, n7) mkd_doc_##n1##_##n2##_##n3##_##n4##_##n5##_##n6##_##n7
27+
#define MKD_DOC8(n1, n2, n3, n4, n5, n6, n7, n8) mkd_doc_##n1##_##n2##_##n3##_##n4##_##n5##_##n6##_##n7##_##n8
28+
#define MKD_DOC9(n1, n2, n3, n4, n5, n6, n7, n8, n9) mkd_doc_##n1##_##n2##_##n3##_##n4##_##n5##_##n6##_##n7##_##n8##_##n9
29+
#define MKD_DOC10(n1, n2, n3, n4, n5, n6, n7, n8, n9, n10) mkd_doc_##n1##_##n2##_##n3##_##n4##_##n5##_##n6##_##n7##_##n8##_##n9##_##n10
30+
#define DOC(...) MKD_EXPAND(MKD_EXPAND(MKD_CAT2(MKD_DOC, MKD_VA_SIZE(__VA_ARGS__)))(__VA_ARGS__))
1331

14-
#define __EXPAND(x) x
15-
#define __COUNT(_1, _2, _3, _4, _5, _6, _7, _8, _9, _10, COUNT, ...) COUNT
16-
#define __VA_SIZE(...) __EXPAND(__COUNT(__VA_ARGS__, 10, 9, 8, 7, 6, 5, 4, 3, 2, 1))
17-
#define __CAT1(a, b) a##b
18-
#define __CAT2(a, b) __CAT1(a, b)
19-
#define __DOC1(n1) __doc_##n1
20-
#define __DOC2(n1, n2) __doc_##n1##_##n2
21-
#define __DOC3(n1, n2, n3) __doc_##n1##_##n2##_##n3
22-
#define __DOC4(n1, n2, n3, n4) __doc_##n1##_##n2##_##n3##_##n4
23-
#define __DOC5(n1, n2, n3, n4, n5) __doc_##n1##_##n2##_##n3##_##n4##_##n5
24-
#define __DOC6(n1, n2, n3, n4, n5, n6) __doc_##n1##_##n2##_##n3##_##n4##_##n5##_##n6
25-
#define __DOC7(n1, n2, n3, n4, n5, n6, n7) __doc_##n1##_##n2##_##n3##_##n4##_##n5##_##n6##_##n7
26-
#define __DOC8(n1, n2, n3, n4, n5, n6, n7, n8) \
27-
__doc_##n1##_##n2##_##n3##_##n4##_##n5##_##n6##_##n7##_##n8
28-
#define __DOC9(n1, n2, n3, n4, n5, n6, n7, n8, n9) \
29-
__doc_##n1##_##n2##_##n3##_##n4##_##n5##_##n6##_##n7##_##n8##_##n9
30-
#define __DOC10(n1, n2, n3, n4, n5, n6, n7, n8, n9, n10) \
31-
__doc_##n1##_##n2##_##n3##_##n4##_##n5##_##n6##_##n7##_##n8##_##n9##_##n10
32-
#define DOC(...) __EXPAND(__EXPAND(__CAT2(__DOC, __VA_SIZE(__VA_ARGS__)))(__VA_ARGS__))
33-
34-
#endif // NEW_DOC_HEADER_HPP
32+
#if defined(__GNUG__)
33+
#pragma GCC diagnostic push
34+
#pragma GCC diagnostic ignored "-Wunused-variable"
35+
#endif
36+
37+
#endif // __DOCSTRINGS_HPP__
3538
#if defined(__GNUG__)
3639
#pragma GCC diagnostic push
3740
#pragma GCC diagnostic ignored "-Wunused-variable"
3841
#endif
3942

4043

41-
static const char *__doc_themachinethatgoesping_pingprocessing_watercolumn_image_make_wci = R"doc()doc";
44+
static const char *mkd_doc_themachinethatgoesping_pingprocessing_watercolumn_image_make_wci = R"doc()doc";
4245

4346
#if defined(__GNUG__)
4447
#pragma GCC diagnostic pop

0 commit comments

Comments
 (0)