@cparra/apexdocs 2.0.0-alpha.15 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -5
- package/docs/.nojekyll +0 -0
- package/docs/README.md +10 -2
- package/docs/Sample-Classes/SampleClass.md +15 -9
- package/docs/Sample-Interfaces/SampleInterface.md +27 -30
- package/docs/index.html +21 -0
- package/examples/force-app/main/default/classes/SampleClass.cls +11 -7
- package/lib/application/Apexdocs.js +6 -3
- package/lib/application/Apexdocs.js.map +1 -1
- package/lib/index.js +11 -4
- package/lib/index.js.map +1 -1
- package/lib/model/file.js +1 -0
- package/lib/model/file.js.map +1 -1
- package/lib/model/manifest-diff.js +1 -0
- package/lib/model/manifest-diff.js.map +1 -1
- package/lib/model/markdown-file.js +1 -0
- package/lib/model/markdown-file.js.map +1 -1
- package/lib/model/markdown-generation-util/doc-comment-annotation-util.d.ts +7 -0
- package/lib/model/markdown-generation-util/doc-comment-annotation-util.js +24 -0
- package/lib/model/markdown-generation-util/doc-comment-annotation-util.js.map +1 -0
- package/lib/model/markdown-generation-util/field-declaration-util.js +1 -0
- package/lib/model/markdown-generation-util/field-declaration-util.js.map +1 -1
- package/lib/model/markdown-generation-util/index.js +13 -6
- package/lib/model/markdown-generation-util/index.js.map +1 -1
- package/lib/model/markdown-generation-util/method-declaration-util.js +3 -0
- package/lib/model/markdown-generation-util/method-declaration-util.js.map +1 -1
- package/lib/model/markdown-generation-util/type-declaration-util.js +4 -9
- package/lib/model/markdown-generation-util/type-declaration-util.js.map +1 -1
- package/lib/model/markdown-home-file.js +1 -0
- package/lib/model/markdown-home-file.js.map +1 -1
- package/lib/model/markdown-type-file.d.ts +2 -0
- package/lib/model/markdown-type-file.js +28 -0
- package/lib/model/markdown-type-file.js.map +1 -1
- package/lib/model/types-repository.d.ts +8 -0
- package/lib/model/types-repository.js +22 -0
- package/lib/model/types-repository.js.map +1 -0
- package/lib/service/apex-file-reader.js +1 -0
- package/lib/service/apex-file-reader.js.map +1 -1
- package/lib/service/file-system.js +1 -0
- package/lib/service/file-system.js.map +1 -1
- package/lib/service/file-writer.js +1 -0
- package/lib/service/file-writer.js.map +1 -1
- package/lib/service/manifest-factory.js +1 -0
- package/lib/service/manifest-factory.js.map +1 -1
- package/lib/service/parser.js +1 -0
- package/lib/service/parser.js.map +1 -1
- package/lib/service/walkers/class-walker.js +1 -0
- package/lib/service/walkers/class-walker.js.map +1 -1
- package/lib/service/walkers/enum-walker.js +1 -0
- package/lib/service/walkers/enum-walker.js.map +1 -1
- package/lib/service/walkers/interface-walker.js +1 -0
- package/lib/service/walkers/interface-walker.js.map +1 -1
- package/lib/service/walkers/walker-factory.js +1 -0
- package/lib/service/walkers/walker-factory.js.map +1 -1
- package/lib/service/walkers/walker.js +1 -0
- package/lib/service/walkers/walker.js.map +1 -1
- package/lib/settings.js +1 -0
- package/lib/settings.js.map +1 -1
- package/lib/transpiler/file-container.js +1 -0
- package/lib/transpiler/file-container.js.map +1 -1
- package/lib/transpiler/markdown/class-file-generatorHelper.d.ts +1 -0
- package/lib/transpiler/markdown/class-file-generatorHelper.js +9 -0
- package/lib/transpiler/markdown/class-file-generatorHelper.js.map +1 -1
- package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.js +1 -0
- package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.js.map +1 -1
- package/lib/transpiler/markdown/markdown-transpiler-base.js +1 -0
- package/lib/transpiler/markdown/markdown-transpiler-base.js.map +1 -1
- package/lib/util/logger.js +1 -0
- package/lib/util/logger.js.map +1 -1
- package/package.json +9 -17
- package/src/application/Apexdocs.ts +6 -4
- package/src/model/markdown-generation-util/doc-comment-annotation-util.ts +29 -0
- package/src/model/markdown-generation-util/method-declaration-util.ts +3 -0
- package/src/model/markdown-generation-util/type-declaration-util.ts +4 -13
- package/src/model/markdown-type-file.ts +32 -0
- package/src/model/types-repository.ts +21 -0
- package/src/transpiler/markdown/class-file-generatorHelper.ts +11 -0
- package/docs/404.html +0 -24
- package/docs/Gemfile +0 -30
- package/docs/Gemfile.lock +0 -279
- package/docs/_config.yml +0 -40
- package/docs/assets/css/style.css +0 -319
- package/docs/index.md +0 -12
- package/examples/apex/SampleClass.cls +0 -113
- package/examples/apex/SampleInterface.cls +0 -16
|
@@ -1,113 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @description This is a class description.
|
|
3
|
-
* @group Sample Classes
|
|
4
|
-
* @CustomAnnotation A Custom annotation
|
|
5
|
-
* @author Cesar Parra
|
|
6
|
-
*/
|
|
7
|
-
@NamespaceAccessible
|
|
8
|
-
public with sharing class SampleClass {
|
|
9
|
-
@NamespaceAccessible
|
|
10
|
-
public enum InnerEnum {
|
|
11
|
-
A,
|
|
12
|
-
B,
|
|
13
|
-
C
|
|
14
|
-
}
|
|
15
|
-
|
|
16
|
-
/**
|
|
17
|
-
* @description Constructs a SampleClass without any arguments.
|
|
18
|
-
* @throws ExcName some exception
|
|
19
|
-
* @CustomAnnotation A Custom annotation
|
|
20
|
-
* @example
|
|
21
|
-
* <pre>
|
|
22
|
-
* // <strong>Example</strong>
|
|
23
|
-
* SampleClass sampleInstance = new SampleClass();
|
|
24
|
-
* </pre>
|
|
25
|
-
*/
|
|
26
|
-
@NamespaceAccessible
|
|
27
|
-
public SampleClass() {
|
|
28
|
-
System.debug('Constructor');
|
|
29
|
-
}
|
|
30
|
-
|
|
31
|
-
/**
|
|
32
|
-
* @description Constructs a SampleClass with an argument.
|
|
33
|
-
* @param argument Argument definition
|
|
34
|
-
*/
|
|
35
|
-
public SampleClass(String argument) {
|
|
36
|
-
System.debug('Constructor');
|
|
37
|
-
}
|
|
38
|
-
|
|
39
|
-
/**
|
|
40
|
-
* @description Executes commands based on the passed in argument.
|
|
41
|
-
* @example
|
|
42
|
-
* <pre>
|
|
43
|
-
* String result = SampleClass.testMethod();
|
|
44
|
-
* System.debug(result);
|
|
45
|
-
* @param argument Argument to debug
|
|
46
|
-
* @return Empty string
|
|
47
|
-
*/
|
|
48
|
-
@NamespaceAccessible
|
|
49
|
-
public static String sampleMethod(String argument) {
|
|
50
|
-
System.debug('Execute');
|
|
51
|
-
return '';
|
|
52
|
-
}
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
/**
|
|
56
|
-
* @description Calls the method.
|
|
57
|
-
* This methods allows you to call it.
|
|
58
|
-
*/
|
|
59
|
-
public static void call() {
|
|
60
|
-
}
|
|
61
|
-
|
|
62
|
-
/**
|
|
63
|
-
* @description This is a String property.
|
|
64
|
-
*/
|
|
65
|
-
@AuraEnabled
|
|
66
|
-
public String MyProp { get; set; }
|
|
67
|
-
|
|
68
|
-
/**
|
|
69
|
-
* @description This is a Decimal property.
|
|
70
|
-
*/
|
|
71
|
-
@AuraEnabled
|
|
72
|
-
public Decimal AnotherProp { get; private set; }
|
|
73
|
-
|
|
74
|
-
/**
|
|
75
|
-
* @description Inner class belonging to SampleClass.
|
|
76
|
-
*/
|
|
77
|
-
public class InnerClass {
|
|
78
|
-
/**
|
|
79
|
-
* @description Description of the inner property.
|
|
80
|
-
*/
|
|
81
|
-
public String InnerProp {
|
|
82
|
-
get;
|
|
83
|
-
set;
|
|
84
|
-
}
|
|
85
|
-
|
|
86
|
-
/**
|
|
87
|
-
* @description Executes from the inner class.
|
|
88
|
-
*/
|
|
89
|
-
public void innerMethod() {
|
|
90
|
-
System.debug('Executing inner method.');
|
|
91
|
-
}
|
|
92
|
-
}
|
|
93
|
-
|
|
94
|
-
/**
|
|
95
|
-
* @description Inner class belonging to SampleClass.
|
|
96
|
-
*/
|
|
97
|
-
public class AnotherInnerClass {
|
|
98
|
-
/**
|
|
99
|
-
* @description Description of the inner property.
|
|
100
|
-
*/
|
|
101
|
-
public String InnerProp {
|
|
102
|
-
get;
|
|
103
|
-
set;
|
|
104
|
-
}
|
|
105
|
-
|
|
106
|
-
/**
|
|
107
|
-
* @description Executes from the inner class.
|
|
108
|
-
*/
|
|
109
|
-
public void innerMethod() {
|
|
110
|
-
System.debug('Executing inner method.');
|
|
111
|
-
}
|
|
112
|
-
}
|
|
113
|
-
}
|
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @description This is an interface description.
|
|
3
|
-
* @group Sample Interfaces
|
|
4
|
-
*/
|
|
5
|
-
global interface SampleInterface {
|
|
6
|
-
/**
|
|
7
|
-
* @description Executes the command.
|
|
8
|
-
*/
|
|
9
|
-
void execute();
|
|
10
|
-
|
|
11
|
-
/**
|
|
12
|
-
* @description Returns a value based on the executed command.
|
|
13
|
-
* @return The value
|
|
14
|
-
*/
|
|
15
|
-
String getValue();
|
|
16
|
-
}
|