Skip to content

Commit f80fdf3

Browse files
authored
Add documentation comments for public imports (#403)
1 parent ce427dd commit f80fdf3

File tree

13 files changed

+24
-0
lines changed

13 files changed

+24
-0
lines changed

source/mir/algebraic_alias/ion.d

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,13 @@ Macros:
1212
module mir.algebraic_alias.ion;
1313

1414
import mir.algebraic: TaggedVariant, This;
15+
///
1516
public import mir.annotated: Annotated;
17+
///
1618
public import mir.lob: Clob, Blob;
19+
///
1720
public import mir.string_map: StringMap;
21+
///
1822
public import mir.timestamp: Timestamp;
1923

2024

source/mir/algebraic_alias/json.d

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Macros:
1212
module mir.algebraic_alias.json;
1313

1414
import mir.algebraic: TaggedVariant, This;
15+
///
1516
public import mir.string_map: StringMap;
1617

1718
/++

source/mir/bignum/decimal.d

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ module mir.bignum.decimal;
88

99
import mir.serde: serdeProxy, serdeScoped;
1010
import std.traits: isSomeChar;
11+
///
1112
public import mir.bignum.low_level_view: DecimalExponentKey;
1213
import mir.bignum.low_level_view: ceilLog10Exp2;
1314

source/mir/interpolate/constant.d

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,8 @@ import mir.rc.array;
4949
import mir.utility: min, max;
5050
import std.meta: AliasSeq, staticMap;
5151
import std.traits;
52+
53+
///
5254
public import mir.interpolate: atInterval;
5355

5456
/++

source/mir/interpolate/generic.d

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,8 @@ import mir.rc.array;
7171
import mir.utility: min, max;
7272
import std.meta: AliasSeq, staticMap;
7373
import std.traits;
74+
75+
///
7476
public import mir.interpolate: atInterval;
7577

7678
/++

source/mir/interpolate/linear.d

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ import mir.rc.array;
2424
import mir.utility: min, max;
2525
import std.meta: AliasSeq, staticMap;
2626
import std.traits;
27+
28+
///
2729
public import mir.interpolate: atInterval;
2830

2931
enum msg_min = "linear interpolant: minimal allowed length for the grid equals 2.";

source/mir/interpolate/polynomial.d

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ T2=$(TR $(TDNW $(LREF $1)) $(TD $+))
1313
+/
1414
module mir.interpolate.polynomial;
1515

16+
///
1617
public import mir.interpolate: atInterval;
1718
import core.lifetime: move;
1819
import mir.functional: RefTuple;

source/mir/interpolate/spline.d

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ import mir.rc.array;
2626
import mir.utility: min, max;
2727
import std.meta: AliasSeq, staticMap;
2828
import std.traits: Unqual;
29+
30+
///
2931
public import mir.interpolate: atInterval;
3032

3133
static immutable msg_min = "spline interpolant: minimal allowed length for the grid equals 2.";

source/mir/math/stat.d

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ import mir.math.sum;
2525
import mir.ndslice.slice: Slice, SliceKind, hasAsSlice;
2626
import mir.primitives;
2727
import std.traits: Unqual, isArray, isMutable, isIterable, isIntegral, CommonType;
28+
29+
///
2830
public import mir.math.sum: Summation;
2931

3032
///

source/mir/ndslice/internal.d

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ template ConstIfPointer(T)
1818
alias ConstIfPointer = T;
1919
}
2020

21+
///
2122
public import mir.utility: _expect;
2223

2324
struct RightOp(string op, T)

0 commit comments

Comments
 (0)