Skip to content

Commit 38d7f7d

Browse files
cesarParracesarParra
authored
Merge pull request #78 from cesarParra/2.15_rc
2.2.15_rc - Documentation root
2 parents 47cef73 + 85185fe commit 38d7f7d

30 files changed

+156
-115
lines changed

‎README.md‎

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -118,21 +118,22 @@ apexdocs-generate
118118

119119
The CLI supports the following parameters:
120120

121-
| Parameter | Alias | Description | Default | Required |
122-
|--------------------|-------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|----------|
123-
| --sourceDir | -s | The directory location which contains your apex .cls classes. | N/A | Yes |
124-
| --targetDir | -t | The directory location where documentation will be generated to. | `docs` | No |
125-
| --recursive | -r | Whether .cls classes will be searched for recursively in the directory provided. | `true` | No |
126-
| --scope | -p | A list of scopes to document. Values should be separated by a space, e.g --scope public private. Note that this setting is ignored if generating an OpenApi REST specification since that looks for classes annotated with @RestResource. | `global` | No |
127-
| --targetGenerator | -g | Define the static file generator for which the documents will be created. Currently supports: `jekyll`, `docsify`, `plain-markdown`, and `openapi`. | `jekyll` | No |
128-
| --indexOnly | N/A | Defines whether only the index file should be generated. | `false` | No |
129-
| --defaultGroupName | N/A | Defines the `@group` name to be used when a file does not specify it. | `Miscellaneous` | No |
130-
| --sanitizeHtml | N/A | When on, any special character within your ApexDocs is converted into its HTML code representation. This is specially useful when generic objects are described within the docs, e.g. "List< Foo>", "Map<Foo, Bar>" because otherwise the content within < and > would be treated as HTML tags and not shown in the output. Content in @example blocks are never sanitized. | `Apex REST Api` | No |
131-
| --openApiTitle | N/A | If using "openapi" as the target generator, this allows you to specify the OpenApi title value. | true | No |
132-
| --title | N/A | Allows you to specify the home page main title. If using "openapi" this acts as an alias to the openApiTitle parameter | `Classes` | No |
133-
| --namespace | N/A | The package namespace, if any. If this value is provided the namespace will be added as a prefix to all of the parsed files. If generating an OpenApi definition, it will be added to the file's Server Url. | N/A | No |
134-
| --openApiFileName | N/A | If using "openapi" as the target generator, this allows you to specify the name of the output file. | `openapi` | No |
135-
| --includeMetadata | N/A | Whether to include the file's meta.xml information: Whether it is active and and the API version | false | No |
121+
| Parameter | Alias | Description | Default | Required |
122+
|------------------------|-------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|----------|
123+
| --sourceDir | -s | The directory location which contains your apex .cls classes. | N/A | Yes |
124+
| --targetDir | -t | The directory location where documentation will be generated to. | `docs` | No |
125+
| --recursive | -r | Whether .cls classes will be searched for recursively in the directory provided. | `true` | No |
126+
| --scope | -p | A list of scopes to document. Values should be separated by a space, e.g --scope public private. Note that this setting is ignored if generating an OpenApi REST specification since that looks for classes annotated with @RestResource. | `global` | No |
127+
| --targetGenerator | -g | Define the static file generator for which the documents will be created. Currently supports: `jekyll`, `docsify`, `plain-markdown`, and `openapi`. | `jekyll` | No |
128+
| --indexOnly | N/A | Defines whether only the index file should be generated. | `false` | No |
129+
| --defaultGroupName | N/A | Defines the `@group` name to be used when a file does not specify it. | `Miscellaneous` | No |
130+
| --sanitizeHtml | N/A | When on, any special character within your ApexDocs is converted into its HTML code representation. This is specially useful when generic objects are described within the docs, e.g. "List< Foo>", "Map<Foo, Bar>" because otherwise the content within < and > would be treated as HTML tags and not shown in the output. Content in @example blocks are never sanitized. | `Apex REST Api` | No |
131+
| --openApiTitle | N/A | If using "openapi" as the target generator, this allows you to specify the OpenApi title value. | true | No |
132+
| --title | N/A | Allows you to specify the home page main title. If using "openapi" this acts as an alias to the openApiTitle parameter | `Classes` | No |
133+
| --namespace | N/A | The package namespace, if any. If this value is provided the namespace will be added as a prefix to all of the parsed files. If generating an OpenApi definition, it will be added to the file's Server Url. | N/A | No |
134+
| --openApiFileName | N/A | If using "openapi" as the target generator, this allows you to specify the name of the output file. | `openapi` | No |
135+
| --includeMetadata | N/A | Whether to include the file's meta.xml information: Whether it is active and and the API version | false | No |
136+
| --documentationRootDir | N/A | The root directory where the documentation will be generated. This is useful when you want to generate the documentation in a subdirectory of your project. | N/A | No |
136137

137138
### Importing to your project
138139

‎docs/Misc-Group/nspc.AnotherInterface.md‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎docs/README.md‎

Lines changed: 1 addition & 84 deletions
Original file line numberDiff line numberDiff line change
@@ -1,84 +1 @@
1-
# Classes
2-
## Misc Group
3-
4-
### [nspc.AnotherInterface](/Misc-Group/nspc.AnotherInterface.md)
5-
6-
7-
### [nspc.ChildClass](/Misc-Group/nspc.ChildClass.md)
8-
9-
10-
### [nspc.GrandparentClass](/Misc-Group/nspc.GrandparentClass.md)
11-
12-
13-
### [nspc.InterfaceWithInheritance](/Misc-Group/nspc.InterfaceWithInheritance.md)
14-
15-
16-
### [nspc.MemberGrouping](/Misc-Group/nspc.MemberGrouping.md)
17-
18-
19-
### [nspc.ParentClass](/Misc-Group/nspc.ParentClass.md)
20-
21-
22-
### [nspc.Reference1](/Misc-Group/nspc.Reference1.md)
23-
24-
25-
### [nspc.Reference2](/Misc-Group/nspc.Reference2.md)
26-
27-
28-
### [nspc.Reference3](/Misc-Group/nspc.Reference3.md)
29-
30-
31-
### [nspc.Reference4](/Misc-Group/nspc.Reference4.md)
32-
33-
34-
### [nspc.Reference5](/Misc-Group/nspc.Reference5.md)
35-
36-
37-
### [nspc.Reference6](/Misc-Group/nspc.Reference6.md)
38-
39-
40-
### [nspc.Reference7](/Misc-Group/nspc.Reference7.md)
41-
42-
43-
### [nspc.SampleClassWithoutModifier](/Misc-Group/nspc.SampleClassWithoutModifier.md)
44-
45-
46-
### [nspc.SampleRestResource](/Misc-Group/nspc.SampleRestResource.md)
47-
48-
Account related operations
49-
50-
51-
52-
### [nspc.SampleRestResourceWithInnerClass](/Misc-Group/nspc.SampleRestResourceWithInnerClass.md)
53-
54-
Contact related operations
55-
56-
57-
58-
### [nspc.SampleRestResourceWithoutApexDocs](/Misc-Group/nspc.SampleRestResourceWithoutApexDocs.md)
59-
60-
Order related operations
61-
62-
63-
## Main
64-
65-
### [nspc.GroupedClass](/Main/nspc.GroupedClass.md)
66-
67-
Uses a block style apex doc
68-
69-
70-
71-
### [nspc.SampleClass](/Main/nspc.SampleClass.md)
72-
73-
This is a class description. This class relates to [nspc.SampleInterface](/Sample-Interfaces/nspc.SampleInterface.md)
74-
But this [ClassThatDoesNotExist](ClassThatDoesNotExist) does not exist.
75-
You can also link using this syntax [nspc.SampleInterface](/Sample-Interfaces/nspc.SampleInterface.md)
76-
77-
78-
## Sample Interfaces
79-
80-
### [nspc.SampleInterface](/Sample-Interfaces/nspc.SampleInterface.md)
81-
82-
This is an interface description.
83-
84-
1+
Go to [docs](/types/README.md) for more information.

‎docs/types/Classes/nspc.AnotherInterface.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# nspc.AnotherInterface
2+
3+
Some desc
4+
5+
6+
**Group** Classes
7+

‎docs/Misc-Group/nspc.ChildClass.md‎ renamed to ‎docs/types/Classes/nspc.ChildClass.md‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,23 @@
11
# nspc.ChildClass
22

3+
Some desc
4+
5+
36
**Inheritance**
47

5-
[nspc.GrandparentClass](/Misc-Group/nspc.GrandparentClass.md)
8+
[nspc.GrandparentClass](types/Misc-Group/nspc.GrandparentClass.md)
69
&gt;
7-
[nspc.ParentClass](/Misc-Group/nspc.ParentClass.md)
10+
[nspc.ParentClass](types/Misc-Group/nspc.ParentClass.md)
811
&gt;
912
ChildClass
1013

1114

1215
**Implemented types**
1316

14-
[nspc.SampleInterface](/Sample-Interfaces/nspc.SampleInterface.md)
17+
[nspc.SampleInterface](types/Sample-Interfaces/nspc.SampleInterface.md)
18+
19+
20+
**Group** Classes
1521

1622
## Fields
1723

‎docs/Main/nspc.GroupedClass.md‎ renamed to ‎docs/types/Main/nspc.GroupedClass.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,5 @@ Uses a block style apex doc
66
**Group** Main
77

88

9-
**Test Class** [nspc.SampleClass](/Main/nspc.SampleClass.md)
9+
**Test Class** [nspc.SampleClass](types/Main/nspc.SampleClass.md)
1010

‎docs/Main/nspc.SampleClass.md‎ renamed to ‎docs/types/Main/nspc.SampleClass.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
`NAMESPACEACCESSIBLE`
44

5-
This is a class description. This class relates to [nspc.SampleInterface](/Sample-Interfaces/nspc.SampleInterface.md)
5+
This is a class description. This class relates to [nspc.SampleInterface](types/Sample-Interfaces/nspc.SampleInterface.md)
66
But this [ClassThatDoesNotExist](ClassThatDoesNotExist) does not exist.
7-
You can also link using this syntax [nspc.SampleInterface](/Sample-Interfaces/nspc.SampleInterface.md)
7+
You can also link using this syntax [nspc.SampleInterface](types/Sample-Interfaces/nspc.SampleInterface.md)
88

99

1010
**Group** Main
@@ -16,15 +16,15 @@ This is a class description. This class relates to [nspc.SampleInterface](/Sampl
1616
**Author** Cesar Parra
1717

1818

19-
**See** [nspc.SampleInterface](/Sample-Interfaces/nspc.SampleInterface.md)
19+
**See** [nspc.SampleInterface](types/Sample-Interfaces/nspc.SampleInterface.md)
2020

2121
## Constructors
2222
### My Super Group
2323
##### `SampleClass()`
2424

2525
`NAMESPACEACCESSIBLE`
2626

27-
Constructs a SampleClass without any arguments. This relates to [nspc.SampleInterface](/Sample-Interfaces/nspc.SampleInterface.md)
27+
Constructs a SampleClass without any arguments. This relates to [nspc.SampleInterface](types/Sample-Interfaces/nspc.SampleInterface.md)
2828

2929
###### Throws
3030

@@ -36,7 +36,7 @@ Constructs a SampleClass without any arguments. This relates to [nspc.SampleInte
3636
**CustomAnnotation** A Custom method annotation
3737

3838

39-
**See** [nspc.SampleInterface](/Sample-Interfaces/nspc.SampleInterface.md)
39+
**See** [nspc.SampleInterface](types/Sample-Interfaces/nspc.SampleInterface.md)
4040

4141
###### Example
4242
```apex

‎docs/Misc-Group/nspc.GrandparentClass.md‎ renamed to ‎docs/types/Misc-Group/nspc.GrandparentClass.md‎

File renamed without changes.

‎docs/Misc-Group/nspc.InterfaceWithInheritance.md‎ renamed to ‎docs/types/Misc-Group/nspc.InterfaceWithInheritance.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
**Extended types**
44

5-
[nspc.SampleInterface](/Sample-Interfaces/nspc.SampleInterface.md)
5+
[nspc.SampleInterface](types/Sample-Interfaces/nspc.SampleInterface.md)
66
,
7-
[nspc.AnotherInterface](/Misc-Group/nspc.AnotherInterface.md)
7+
[nspc.AnotherInterface](types/Classes/nspc.AnotherInterface.md)
88
## Methods
99
### `execute()`
1010

‎docs/Misc-Group/nspc.MemberGrouping.md‎ renamed to ‎docs/types/Misc-Group/nspc.MemberGrouping.md‎

File renamed without changes.

0 commit comments

Comments
 (0)