Skip to content

Commit 4b9eada

Browse files
cesarParracesarParra
authored
Merge pull request #202 from cesarParra/config-typo-fix
Fixing typo with CLI configuration name
2 parents 2aa4467 + 1521452 commit 4b9eada

File tree

60 files changed

+1917
-21
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

60 files changed

+1917
-21
lines changed

‎README.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -111,17 +111,17 @@ apexdocs changelog --previousVersionDir force-app-previous --currentVersionDir f
111111

112112
#### Flags
113113

114-
| Flag | Alias | Description | Default | Required |
115-
|---------------------------|-------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|----------|
116-
| `--sourceDir` | `-s` | The directory where the source files are located. | N/A | Yes |
117-
| `--targetDir` | `-t` | The directory where the generated files will be placed. | `docs` | No |
118-
| `--scope` | `-p` | A list of scopes to document. Values should be separated by a space, e.g --scope global public namespaceaccessible. | `global` | No |
119-
| `--defaultGroupName` | N/A | The default group name to use when a group is not specified. | `Miscellaneous` | No |
120-
| `--namespace` | N/A | The package namespace, if any. If provided, it will be added to the generated files. | N/A | No |
121-
| `--sortAlphabetically` | N/A | Sorts files appearing in the Reference Guide alphabetically, as well as the members of a class, interface or enum alphabetically. If false, the members will be displayed in the same order as the code. | `false` | No |
122-
| `--includeMetadata ` | N/A | Whether to include the file's meta.xml information: Whether it is active and and the API version | `false` | No |
123-
| `--linkingStrategy` | N/A | The strategy to use when linking to other classes. Possible values are `relative`, `no-link`, and `none` | `relative` | No |
124-
| `--customObjectGroupName` | N/A | The name under which custom objects will be grouped in the Reference Guide | `Custom Objects` | No |
114+
| Flag | Alias | Description | Default | Required |
115+
|----------------------------|-------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|----------|
116+
| `--sourceDir` | `-s` | The directory where the source files are located. | N/A | Yes |
117+
| `--targetDir` | `-t` | The directory where the generated files will be placed. | `docs` | No |
118+
| `--scope` | `-p` | A list of scopes to document. Values should be separated by a space, e.g --scope global public namespaceaccessible. | `global` | No |
119+
| `--defaultGroupName` | N/A | The default group name to use when a group is not specified. | `Miscellaneous` | No |
120+
| `--namespace` | N/A | The package namespace, if any. If provided, it will be added to the generated files. | N/A | No |
121+
| `--sortAlphabetically` | N/A | Sorts files appearing in the Reference Guide alphabetically, as well as the members of a class, interface or enum alphabetically. If false, the members will be displayed in the same order as the code. | `false` | No |
122+
| `--includeMetadata ` | N/A | Whether to include the file's meta.xml information: Whether it is active and and the API version | `false` | No |
123+
| `--linkingStrategy` | N/A | The strategy to use when linking to other classes. Possible values are `relative`, `no-link`, and `none` | `relative` | No |
124+
| `--customObjectsGroupName` | N/A | The name under which custom objects will be grouped in the Reference Guide | `Custom Objects` | No |
125125

126126
##### Linking Strategy
127127

‎examples/changelog/current/classes/AccountService.cls-meta.xml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
3+
<apiVersion>62.0</apiVersion>
4+
<status>Active</status>
5+
</ApexClass>

‎examples/changelog/current/classes/IAnotherExample.cls-meta.xml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
3+
<apiVersion>62.0</apiVersion>
4+
<status>Active</status>
5+
</ApexClass>

‎examples/changelog/current/classes/IExemplificable.cls-meta.xml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
3+
<apiVersion>62.0</apiVersion>
4+
<status>Active</status>
5+
</ApexClass>

‎examples/changelog/current/classes/PossibleValues.cls-meta.xml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
3+
<apiVersion>62.0</apiVersion>
4+
<status>Active</status>
5+
</ApexClass>

‎examples/changelog/current/classes/SolidService.cls-meta.xml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
3+
<apiVersion>62.0</apiVersion>
4+
<status>Active</status>
5+
</ApexClass>

‎examples/changelog/previous/OldImplementation.cls-meta.xml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
3+
<apiVersion>62.0</apiVersion>
4+
<status>Active</status>
5+
</ApexClass>

‎examples/changelog/previous/SolidService.cls-meta.xml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
3+
<apiVersion>62.0</apiVersion>
4+
<status>Active</status>
5+
</ApexClass>

‎examples/markdown/docs/custom-objects/Event__c.md‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# Event
2+
3+
Represents an event that people can register for.
4+
5+
## API Name
6+
`ns__Event__c`
7+
8+
## Fields
9+
### Description
10+
11+
**API Name**
12+
13+
`ns__Description__c`
14+
15+
**Type**
16+
17+
*LongTextArea*
18+
19+
---
20+
### End Date
21+
22+
**API Name**
23+
24+
`ns__End_Date__c`
25+
26+
**Type**
27+
28+
*Date*
29+
30+
---
31+
### Location
32+
33+
**API Name**
34+
35+
`ns__Location__c`
36+
37+
**Type**
38+
39+
*Location*
40+
41+
---
42+
### Start Date
43+
44+
**API Name**
45+
46+
`ns__Start_Date__c`
47+
48+
**Type**
49+
50+
*Date*
51+
52+
---
53+
### Tag Line
54+
55+
**API Name**
56+
57+
`ns__Tag_Line__c`
58+
59+
**Type**
60+
61+
*Text*

‎examples/markdown/docs/custom-objects/Price_Component__c.md‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# Price Component
2+
3+
## API Name
4+
`ns__Price_Component__c`
5+
6+
## Fields
7+
### Description
8+
9+
**API Name**
10+
11+
`ns__Description__c`
12+
13+
**Type**
14+
15+
*Text*
16+
17+
---
18+
### Expression
19+
20+
The Expression that determines if this price should take effect or not.
21+
22+
**API Name**
23+
24+
`ns__Expression__c`
25+
26+
**Type**
27+
28+
*LongTextArea*
29+
30+
---
31+
### Percent
32+
33+
Use this field to calculate the price based on the list price&#x27;s percentage instead of providing a flat price.
34+
35+
**API Name**
36+
37+
`ns__Percent__c`
38+
39+
**Type**
40+
41+
*Percent*
42+
43+
---
44+
### Price
45+
46+
Use this when the Price Component represents a Flat Price. To represent a Percentage use the Percent field.
47+
48+
**API Name**
49+
50+
`ns__Price__c`
51+
52+
**Type**
53+
54+
*Currency*
55+
56+
---
57+
### Type
58+
59+
**API Name**
60+
61+
`ns__Type__c`
62+
63+
**Type**
64+
65+
*Picklist*

0 commit comments

Comments
 (0)