Skip to content

Commit becb4a7

Browse files
committed
Changes specs format to satisfy FORD v7.0
2 parents b0f769e + 7f614e0 commit becb4a7

27 files changed

+257
-256
lines changed

doc/specs/stdlib_ansi.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,7 @@ Generic interface to turn a style, foreground or background enumerator into an a
194194

195195
#### Syntax
196196

197-
`string = [[stdlib_string_colors(module):to_string(interface)]] (code)`
197+
`string =` [[stdlib_ansi(module):to_string(interface)]] `(code)`
198198

199199
#### Class
200200

doc/specs/stdlib_array.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ The built-in / intrinsics are usually preferable to `trueloc`, unless the access
2727

2828
#### Syntax
2929

30-
`loc = [[trueloc(function)]] (array[, lbound])`
30+
`loc =` [[trueloc(function)]] `(array[, lbound])`
3131

3232
#### Class
3333

@@ -64,7 +64,7 @@ The built-in / intrinsics are usually preferable to `falseloc`, unless the acces
6464

6565
#### Syntax
6666

67-
`loc = [[falseloc(function)]] (array[, lbound])`
67+
`loc =` [[falseloc(function)]] `(array[, lbound])`
6868

6969
#### Class
7070

doc/specs/stdlib_ascii.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Converts input character variable to all lowercase.
3434

3535
#### Syntax
3636

37-
`res = [[stdlib_ascii(module):to_lower(function)]] (string)`
37+
`res =` [[stdlib_ascii(module):to_lower(function)]] `(string)`
3838

3939
#### Class
4040

@@ -66,7 +66,7 @@ Converts input character variable to all uppercase.
6666

6767
#### Syntax
6868

69-
`res = [[stdlib_ascii(module):to_upper(function)]] (string)`
69+
`res =` [[stdlib_ascii(module):to_upper(function)]] `(string)`
7070

7171
#### Class
7272

@@ -103,7 +103,7 @@ or numeral present next to either of its 2 ends.
103103

104104
#### Syntax
105105

106-
`res = [[stdlib_ascii(module):to_title(function)]] (string)`
106+
`res =` [[stdlib_ascii(module):to_title(function)]] `(string)`
107107

108108
#### Class
109109

@@ -138,7 +138,7 @@ transformed to lowercase.
138138

139139
#### Syntax
140140

141-
`res = [[stdlib_ascii(module):to_sentence(function)]] (string)`
141+
`res =` [[stdlib_ascii(module):to_sentence(function)]] `(string)`
142142

143143
#### Class
144144

@@ -170,7 +170,7 @@ Reverses the order of all characters in the input character type.
170170

171171
#### Syntax
172172

173-
`res = [[stdlib_ascii(module):reverse(function)]] (string)`
173+
`res =` [[stdlib_ascii(module):reverse(function)]] `(string)`
174174

175175
#### Class
176176

doc/specs/stdlib_bitsets.md

+37-37
Original file line numberDiff line numberDiff line change
@@ -78,13 +78,13 @@ position, that, in turn, is indexed from 0 to `bits-1`. `bitset_type` is
7878
used only as a `class` to define entities that can be either a `bitset_64` or
7979
a `bitset_large`. The syntax for using the types are:
8080

81-
`class([[stdlib_bitsets(module):bitset_type(type)]]) :: variable`
81+
`class(` [[stdlib_bitsets(module):bitset_type(type)]] `) :: variable`
8282

83-
`type([[stdlib_bitsets(module):bitset_64(type)]]) :: variable`
83+
`type(` [[stdlib_bitsets(module):bitset_64(type)]] `) :: variable`
8484

8585
and
8686

87-
`type([[stdlib_bitsets(module):bitset_large(type)]]) :: variable`
87+
`type(` [[stdlib_bitsets(module):bitset_large(type)]] `) :: variable`
8888

8989
## The *bitset-literal*
9090

@@ -239,7 +239,7 @@ Determines whether all bits are set to 1 in `self`.
239239

240240
#### Syntax
241241

242-
`result = self % [[bitset_type(type):all(bound)]]()`
242+
`result = self % ` [[bitset_type(type):all(bound)]] `()`
243243

244244
#### Class
245245

@@ -276,7 +276,7 @@ number of bits, otherwise the result is undefined.
276276

277277
#### Syntax
278278

279-
`call [[stdlib_bitsets(module):and(interface)]](set1, set2)`
279+
`call ` [[stdlib_bitsets(module):and(interface)]] `(set1, set2)`
280280

281281
#### Class
282282

@@ -314,7 +314,7 @@ result is undefined.
314314

315315
#### Syntax
316316

317-
`call [[stdlib_bitsets(module):and_not(interface)]](set1, set2)`
317+
`call ` [[stdlib_bitsets(module):and_not(interface)]] `(set1, set2)`
318318

319319
#### Class
320320

@@ -349,7 +349,7 @@ Determines whether any bits are set in `self`.
349349

350350
#### Syntax
351351

352-
`result = self % [[bitset_type(type):any(bound)]]()`
352+
`result = self % ` [[bitset_type(type):any(bound)]] `()`
353353

354354
#### Class
355355

@@ -383,7 +383,7 @@ Returns the number of bits that are set to one in `self`.
383383

384384
#### Syntax
385385

386-
`result = self % [[bitset_type(type):bit_count(bound)]] ()`
386+
`result = self % ` [[bitset_type(type):bit_count(bound)]] ` ()`
387387

388388
#### Class
389389

@@ -417,7 +417,7 @@ Reports the number of bits in `self`.
417417

418418
#### Syntax
419419

420-
`result = self % [[bitset_type(type):bits(bound)]] ()`
420+
`result = self % ` [[bitset_type(type):bits(bound)]] ` ()`
421421

422422
#### Class
423423

@@ -460,11 +460,11 @@ Note: Positions outside the range 0 to `bits(set) -1` are ignored.
460460

461461
#### Syntax
462462

463-
`call self % [[bitset_type(type):clear(bound)]](pos)`
463+
`call self % ` [[bitset_type(type):clear(bound)]] `(pos)`
464464

465465
or
466466

467-
`call self % [[bitset_type(type):clear(bound)]](start_pos, end_pos)`
467+
`call self % ` [[bitset_type(type):clear(bound)]] `(start_pos, end_pos)`
468468

469469
#### Class
470470

@@ -507,7 +507,7 @@ informative message.
507507

508508
#### Syntax
509509

510-
`call [[stdlib_bitsets(module):extract(interface)]](new, old, start_pos, stop_pos, status )`
510+
`call ` [[stdlib_bitsets(module):extract(interface)]] `(new, old, start_pos, stop_pos, status )`
511511

512512
#### Class
513513

@@ -563,11 +563,11 @@ flip the bit values with positions from `start_pos` to `end_pos` in
563563

564564
#### Syntax
565565

566-
`call self % [[bitset_type(type):flip(bound)]] (pos)`
566+
`call self % ` [[bitset_type(type):flip(bound)]] ` (pos)`
567567

568568
or
569569

570-
`call self % [[bitset_type(type):flip(bound)]] (start_pos, end_pos)`
570+
`call self % ` [[bitset_type(type):flip(bound)]] ` (start_pos, end_pos)`
571571

572572
#### Class
573573

@@ -606,7 +606,7 @@ binary literal.
606606

607607
#### Syntax
608608

609-
`call self % [[bitset_type(type):from_string(bound)]](string[, status])`
609+
`call self % ` [[bitset_type(type):from_string(bound)]] `(string[, status])`
610610

611611
#### Class
612612

@@ -655,7 +655,7 @@ Experimental
655655

656656
#### Syntax
657657

658-
`call self % [[bitset_type(type):init(bound)]] (bits [, status])`
658+
`call self % ` [[bitset_type(type):init(bound)]] ` (bits [, status])`
659659

660660
#### Class
661661

@@ -705,7 +705,7 @@ file.
705705

706706
#### Syntax
707707

708-
`call self % [[bitset_type(type):input(bound)]] (unit [, status])`
708+
`call self % ` [[bitset_type(type):input(bound)]] ` (unit [, status])`
709709

710710
#### Class
711711

@@ -757,7 +757,7 @@ Determines whether no bits are set in `self`.
757757

758758
#### Syntax
759759

760-
`result = self % [[bitset_type(type):none(bound)]] ()`
760+
`result = self % ` [[bitset_type(type):none(bound)]] ` ()`
761761

762762
#### Class
763763

@@ -792,7 +792,7 @@ Performs the logical complement on the bits of `self`.
792792

793793
#### Syntax
794794

795-
`call self % [[bitset_type(type):not(bound)]] ()`
795+
`call self % ` [[bitset_type(type):not(bound)]] ` ()`
796796

797797
#### Class
798798

@@ -824,7 +824,7 @@ same number of bits, otherwise the result is undefined.
824824

825825
#### Syntax
826826

827-
`call [[stdlib_bitsets(module):or(interface)]](set1, set2)`
827+
`call ` [[stdlib_bitsets(module):or(interface)]] `(set1, set2)`
828828

829829
#### Class
830830

@@ -859,7 +859,7 @@ Writes a binary representation of a bitset to an unformatted file.
859859

860860
#### Syntax
861861

862-
`call self % [[bitset_type(type):output(bound)]] (unit[, status])`
862+
`call self % ` [[bitset_type(type):output(bound)]] ` (unit[, status])`
863863

864864
#### Class
865865

@@ -904,11 +904,11 @@ value.
904904

905905
#### Syntax
906906

907-
`call self % [[bitset_type(type):read_bitset(bound)]](string[, status])`
907+
`call self % ` [[bitset_type(type):read_bitset(bound)]] `(string[, status])`
908908

909909
or
910910

911-
`call self % [[bitset_type(type):read_bitset(bound)]](unit[, advance, status])`
911+
`call self % ` [[bitset_type(type):read_bitset(bound)]] `(unit[, advance, status])`
912912

913913

914914
#### Class
@@ -995,11 +995,11 @@ set the bits at positions from `start_pos` to `end_pos` in `self` to 1.
995995

996996
#### Syntax
997997

998-
`call self % [[bitset_type(type):set(bound)]] (POS)`
998+
`call self % ` [[bitset_type(type):set(bound)]] ` (POS)`
999999

10001000
or
10011001

1002-
`call self % [[bitset_type(type):set(bound)]] (START_POS, END_POS)`
1002+
`call self % ` [[bitset_type(type):set(bound)]] ` (START_POS, END_POS)`
10031003

10041004
#### Class
10051005

@@ -1038,7 +1038,7 @@ Determine whether the bit at position `pos` is set to 1 in `self`.
10381038

10391039
#### Syntax
10401040

1041-
`result = self % [[bitset_type(type):test(bound)]](pos)`
1041+
`result = self % ` [[bitset_type(type):test(bound)]] `(pos)`
10421042

10431043
#### Class
10441044

@@ -1077,7 +1077,7 @@ Represents the value of `self` as a binary literal in `string`.
10771077

10781078
#### Syntax
10791079

1080-
`call self % [[bitset_type(type):to_string(bound)]](string[, status])`
1080+
`call self % ` [[bitset_type(type):to_string(bound)]] `(string[, status])`
10811081

10821082
#### Class
10831083

@@ -1121,7 +1121,7 @@ Determines the value of the bit at position, `pos`, in `self`.
11211121

11221122
#### Syntax
11231123

1124-
`result = self % [[bitset_type(type):value(bound)]](pos)`
1124+
`result = self % ` [[bitset_type(type):value(bound)]] `(pos)`
11251125

11261126
#### Class
11271127

@@ -1162,11 +1162,11 @@ character string or formatted file.
11621162

11631163
#### Syntax
11641164

1165-
`call self % [[bitset_type(type):write_bitset(bound)]](string[, status])`
1165+
`call self % ` [[bitset_type(type):write_bitset(bound)]] `(string[, status])`
11661166

11671167
or
11681168

1169-
`call self % [[bitset_type(type):write_bitset(bound)]] (unit[, advance, status])`
1169+
`call self % ` [[bitset_type(type):write_bitset(bound)]] ` (unit[, advance, status])`
11701170

11711171
#### Class
11721172

@@ -1229,7 +1229,7 @@ the samee number of bits, otherwise the result is undefined.
12291229

12301230
#### Syntax
12311231

1232-
`result = [[stdlib_bitsets(module):xor(interface)]] (set1, set2)`
1232+
`result = ` [[stdlib_bitsets(module):xor(interface)]] ` (set1, set2)`
12331233

12341234
#### Class
12351235

@@ -1267,7 +1267,7 @@ Returns `.true.` if all bits in `set1` and `set2` have the same value,
12671267

12681268
#### Syntax
12691269

1270-
`result = set1 [[stdlib_bitsets(module):==(interface)]] set2`
1270+
`result = set1 ` [[stdlib_bitsets(module):==(interface)]] ` set2`
12711271

12721272
or
12731273

@@ -1311,7 +1311,7 @@ Returns `.true.` if any bits in `self` and `set2` differ in value,
13111311

13121312
#### Syntax
13131313

1314-
`result = set1 [[stdlib_bitsets(module):/=(interface)]] set2`
1314+
`result = set1 ` [[stdlib_bitsets(module):/=(interface)]] ` set2`
13151315

13161316
or
13171317

@@ -1357,7 +1357,7 @@ results are undefined.
13571357

13581358
#### Syntax
13591359

1360-
`result = set1 [[stdlib_bitsets(module):>=(interface)]] set2`
1360+
`result = set1 ` [[stdlib_bitsets(module):>=(interface)]] ` set2`
13611361

13621362
or
13631363

@@ -1404,7 +1404,7 @@ results are undefined.
14041404

14051405
#### Syntax
14061406

1407-
`result = set1 [[stdlib_bitsets(module):>(interface)]] set2`
1407+
`result = set1 ` [[stdlib_bitsets(module):>(interface)]] ` set2`
14081408

14091409
or
14101410

@@ -1451,7 +1451,7 @@ results are undefined.
14511451

14521452
#### Syntax
14531453

1454-
`result = set1 [[stdlib_bitsets(module):<=(interface)]] set2`
1454+
`result = set1 ` [[stdlib_bitsets(module):<=(interface)]] ` set2`
14551455

14561456
or
14571457

@@ -1498,7 +1498,7 @@ results are undefined.
14981498

14991499
#### Syntax
15001500

1501-
`result = set1 [[stdlib_bitsets(module):<(interface)]] set2`
1501+
`result = set1 ` [[stdlib_bitsets(module):<(interface)]] ` set2`
15021502

15031503
or
15041504

doc/specs/stdlib_error.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Checks the value of a logical condition.
2525

2626
#### Syntax
2727

28-
`call [[check(subroutine)]](condition, msg, code, warn)`
28+
`call ` [[check(subroutine)]] `(condition, msg, code, warn)`
2929

3030

3131
#### Arguments
@@ -77,7 +77,7 @@ Aborts the program with a message and a nonzero exit code.
7777

7878
#### Syntax
7979

80-
`call [[stdlib_error(module):error_stop(interface)]](msg, code)`
80+
`call ` [[stdlib_error(module):error_stop(interface)]] `(msg, code)`
8181

8282
#### Arguments
8383

0 commit comments

Comments
 (0)