salesforce-trigger-framework/apexdox.yml at main · dschach/salesforce-trigger-framework · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
engine:
  source:
    - path: "${workspaceFolder}/force-app/main/default/classes"
      sourceUrl: https://github.com/dschach/salesforce-trigger-framework/tree/main/force-app/main/default/classes
    - path: "${workspaceFolder}/sample-handler/main/default/classes"
      sourceUrl: https://github.com/dschach/salesforce-trigger-framework/tree/main/sample-handler/main/default/classes
  targetDirectory: "${workspaceFolder}/docs"
  #excludes:
  #  - "*Test.cls"
  title: Salesforce Trigger Handler code documentation
  subtitle: Documentation for <a target="_blank" rel="noopener noreferrer" href="https://github.com/dschach/salesforce-trigger-framework">Trigger Framework</a>
  sortOrder: alpha
  cleanDir: true # keep prettier config file
  showTOCSnippets: true
  scope:
    - public
    - private
    - protected
    - testMethod
  homePagePath: "${workspaceFolder}/doc-assets/homePage.html"
  pages:
    - "${workspaceFolder}/doc-assets/files/deploy.html"
    - "${workspaceFolder}/doc-assets/files/changelog.html"
  assets:
    - "${workspaceFolder}/doc-assets/favicon.png"
    - "${workspaceFolder}/doc-assets/highlight.css"
    - "${workspaceFolder}/doc-assets/highlight.js"
    - "${workspaceFolder}/doc-assets/icon.png"
    - "${workspaceFolder}/doc-assets/index.css"
    - "${workspaceFolder}/doc-assets/index.js"
    - "${workspaceFolder}/doc-assets/logo.png"
    - "${workspaceFolder}/doc-assets/styling.css"
    #- "${workspaceFolder}/doc-assets/files/sampletriggerhandlerhome.html"
  port: 9090
docblock:
  alignItems: true
  spacious: true
  omitDescriptionTag: false