Skip to content

Commit 7a0e138

Browse files
committed
Rename page to VisibleMembers
1 parent 8eddadb commit 7a0e138

5 files changed

Lines changed: 49 additions & 43 deletions

File tree

src/CommandLine.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ Do not require the markers given in `--marker` but remove them from the comment
8484
--numericfilenames::
8585
Causes the html generator to create numeric filenames
8686

87-
link:IncludeByVisibility[-M, --visible-members]::
87+
link:VisibleMembers[-M, --visible-members]::
8888
Include / Exclude class Members by visiblity
8989

9090
link:WriteUsesList[--write-uses-list]::

src/IncludeByVisibility.asciidoc

Lines changed: 1 addition & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1 @@
1-
:doctitle: --visible-members command-line option
2-
3-
The link:CommandLine[CommandLine] option `--visible-members` (short
4-
form is `-M`) controls what class members are visible in final
5-
documentation. The following visibility types are known:
6-
7-
* `private`
8-
* `strictprivate`
9-
* `protected`
10-
* `strictprotected`
11-
* `public`
12-
* `published`
13-
* `automated`
14-
* `implicit` (which can mean either `public` or `published`; see link:ImplicitVisibilityOption[--implicit-visibility option])
15-
16-
Example:
17-
18-
----
19-
pasdoc --visible-members protected,public,published,automated
20-
----
21-
22-
By default `private` and `implicit` members are hidden, the rest is shown.
23-
24-
== Make some members "included but hidden by default"
25-
26-
Moreover, you can specify some visibility levels as "included but hidden by default" by adding `?` at the end of the visibility level name.
27-
28-
The main use-case is for `protected` and `strictprotected` visibility levels, which:
29-
30-
- on one hand, deserve to be mentioned and documented (developers using the class need to know about them, to be able to develop descendants),
31-
32-
- on the other hand, sometimes we don't want the `protected` stuff to clutter the default view too much, because _most_ developers are fine just exploring the `public` identifiers.
33-
34-
Now you can have a cake, and eat it too :), by specifying the "included but hidden by default" visibility levels with `?` at the end for the `--visible-members` option. Like this:
35-
36-
```
37-
pasdoc --visible-members=protected?,public,published *.pas
38-
```
39-
40-
This results in `protected` members included but hidden by default in the HTML output. We will show a checkbox to allow user to show/hide them (using JavaScript, so no page reload).
1+
`--visible-members` docs moved to link:VisibleMembers[] page.

src/VisibleMembers.asciidoc

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
:doctitle: --visible-members command-line option
2+
:sectnums:
3+
:toc: left
4+
:toclevels: 4
5+
6+
== What members to include in the documentation
7+
8+
The link:CommandLine[CommandLine] option `--visible-members` (short
9+
form is `-M`) controls what class members are visible in final
10+
documentation. The following visibility types are known:
11+
12+
* `private`
13+
* `strictprivate`
14+
* `protected`
15+
* `strictprotected`
16+
* `public`
17+
* `published`
18+
* `automated`
19+
* `implicit` (which can mean either `public` or `published`; see link:ImplicitVisibilityOption[--implicit-visibility option])
20+
21+
Example:
22+
23+
----
24+
pasdoc --visible-members protected,public,published,automated
25+
----
26+
27+
By default `private` and `implicit` members are hidden, the rest is shown.
28+
29+
== Make some members "included but hidden by default"
30+
31+
Moreover, you can specify some visibility levels as "included but hidden by default" by adding `?` at the end of the visibility level name.
32+
33+
The main use-case is for `protected` and `strictprotected` visibility levels, which:
34+
35+
- on one hand, deserve to be mentioned and documented (developers using the class need to know about them, to be able to develop descendants),
36+
37+
- on the other hand, sometimes we don't want the `protected` stuff to clutter the default view too much, because _most_ developers are fine just exploring the `public` identifiers.
38+
39+
Now you can have a cake, and eat it too :), by specifying the "included but hidden by default" visibility levels with `?` at the end for the `--visible-members` option. Like this:
40+
41+
```
42+
pasdoc --visible-members=protected?,public,published *.pas
43+
```
44+
45+
This results in `protected` members included but hidden by default in the HTML output. We will show a checkbox to allow user to show/hide them (using JavaScript, so no page reload).

src/_Sidebar.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ link:CommandLine[Command Line]: ::
7373
* link:IntroductionAndConclusion[--introduction, --conclusion, -A, --additional]
7474
* link:ImplicitVisibilityOption[--implicit-visibility]
7575
* link:TrueFalseNilTag[--lowercase-keywords]
76-
* link:IncludeByVisibility[--visible-members]
76+
* link:VisibleMembers[--visible-members]
7777
* link:IncludeCreationTimeOption[--include-creation-time]
7878
* link:IncludeInSearchPath[--include]
7979
* link:LinkLookOption[--link-look]

src/_includes/sidebar.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@
131131

132132
* [\--lowercase-keywords](TrueFalseNilTag)
133133

134-
* [\--visible-members](IncludeByVisibility)
134+
* [\--visible-members](VisibleMembers)
135135

136136
* [\--include-creation-time](IncludeCreationTimeOption)
137137

0 commit comments

Comments
 (0)