docs: ApexDox updates

dschach · Feb 10, 2023 · 68b1038 · 68b1038
1 parent d361bac
commit 68b1038
Show file tree

Hide file tree

Showing 25 changed files with 4,416 additions and 273 deletions.
diff --git a/doc-assets/files/CMStatuses.png → doc-assets/assets/CMStatuses.png b/doc-assets/files/CMStatuses.png → doc-assets/assets/CMStatuses.png
diff --git a/...-Protected-Campaign-Member-Statuses-1.png → ...-Protected-Campaign-Member-Statuses-1.png b/...-Protected-Campaign-Member-Statuses-1.png → ...-Protected-Campaign-Member-Statuses-1.png
diff --git a/...-Protected-Campaign-Member-Statuses-2.png → ...-Protected-Campaign-Member-Statuses-2.png b/...-Protected-Campaign-Member-Statuses-2.png → ...-Protected-Campaign-Member-Statuses-2.png
diff --git a/...-Protected-Campaign-Member-Statuses-3.png → ...-Protected-Campaign-Member-Statuses-3.png b/...-Protected-Campaign-Member-Statuses-3.png → ...-Protected-Campaign-Member-Statuses-3.png
diff --git a/...-Protected-Campaign-Member-Statuses-4.png → ...-Protected-Campaign-Member-Statuses-4.png b/...-Protected-Campaign-Member-Statuses-4.png → ...-Protected-Campaign-Member-Statuses-4.png
diff --git a/...-Protected-Campaign-Member-Statuses-5.png → ...-Protected-Campaign-Member-Statuses-5.png b/...-Protected-Campaign-Member-Statuses-5.png → ...-Protected-Campaign-Member-Statuses-5.png
diff --git a/doc-assets/files/README.md → doc-assets/assets/README.md b/doc-assets/files/README.md → doc-assets/assets/README.md
diff --git a/doc-assets/campaignmemberstatushome.html b/doc-assets/campaignmemberstatushome.html
@@ -10,7 +10,7 @@ <h2 id="get-a-solution-for-protected-campaign-member-statuses-in-pardot-and-step
 	</p>
 
 	<p>
-		When a new Salesforce Campaign is created, many people aren’t just happy with the two default statuses of Sent and Responded. This prompts them to create what they think makes
+		When a new Salesforce Campaign is created, many people aren't just happy with the two default statuses of Sent and Responded. This prompts them to create what they think makes
 		the most sense. Though as time goes on and as reporting starts to be needed, everyone making their own Campaign Member Statuses can be a nightmare that prevents you from
 		getting meaningful and actionable intelligence. It would be really nice to take the guesswork out of status reporting and have a standard set of Campaign Member Statuses
 		everyone uses consistently.
@@ -64,7 +64,7 @@ <h3 id="get-started">Get started</h3>
 			<ul>
 				<li>Label: Used in the List of Campaign Statuses in the Setup view in step 3 above. Recommended convention:&nbsp; TYPE-STATUS</li>
 				<li>Name: This is an API name that can be used by developers. Not required by this package. Recommended: let this autofill after you type in the Label.</li>
-				<li>Campaign Type: This is the actual value for the Campaign’s Type field.</li>
+				<li>Campaign Type: This is the actual value for the Campaign's Type field.</li>
 				<li>Protected Status: This is the Status value that will become protected.</li>
 				<li>Is Default: Select this if this Status should be the default (please pick only 1 per Type).</li>
 				<li>Is Responded: Select this if this Status should be marked as Responded.</li>
@@ -110,7 +110,7 @@ <h3 id="get-started">Get started</h3>
 
 	<p>Campaigns with Types not already set up will keep the default two statuses that Salesforce creates.</p>
 
-	<h2 id="that-s-cool-what-s-behind-the-curtain"><strong>That’s cool.</strong> <strong>What’s behind the curtain?</strong></h2>
+	<h2 id="that-s-cool-what-s-behind-the-curtain"><strong>That's cool.</strong> <strong>What's behind the curtain?</strong></h2>
 
 	<p>To accomplish this, we leverage a few cool tools available to us:</p>
 
@@ -121,15 +121,15 @@ <h2 id="that-s-cool-what-s-behind-the-curtain"><strong>That’s cool.</strong> <
 		</li>
 		<li>
 			Campaign Custom Field: Has_Protected_Campaign_Member_Statuses__c is automatically checked by the solution if a Campaign is created and there are Custom Metadata Type records
-			that specify this Campaign’s Type. It is also what allows the rest of the code to keep the statuses intact. You can clear the checkbox for this field to make changes to the
-			statuses if you need to. However, you can’t enable protection afterwards.
+			that specify this Campaign's Type. It is also what allows the rest of the code to keep the statuses intact. You can clear the checkbox for this field to make changes to the
+			statuses if you need to. However, you can't enable protection afterwards.
 		</li>
 		<li>
-			Change Data Capture: We turn this on for CampaignMemberStatus so we can detect edits to statuses and then fix the records after-the-fact. Sadly we can’t (yet?) put any
+			Change Data Capture: We turn this on for CampaignMemberStatus so we can detect edits to statuses and then fix the records after-the-fact. Sadly we can't (yet?) put any
 			triggers on CampaignMemberStatus (which would have been ideal).
 		</li>
 		<li>
-			Triggers: We use them to kick off the automation that we’ve built when a Campaign is created. We also use them to watch for Campaign Member Status edits (through the
+			Triggers: We use them to kick off the automation that we've built when a Campaign is created. We also use them to watch for Campaign Member Status edits (through the
 			ChangeEvents from Change Data Capture) so we can set things right afterwardsd.
 		</li>
 	</ul>

diff --git a/doc-assets/setupApexDox.sh b/doc-assets/setupApexDox.sh
@@ -0,0 +1,22 @@
+#!/bin/sh
+
+# Run this BEFORE running ApexDox so all your files are set up properly.
+
+#curl -L "https://raw.githubusercontent.com/dschach/salesforce-trigger-framework/main/README.md" -o "doc-assets/files/triggerHandlerReadMe.md"
+npx marked -i doc-assets/files/triggerHandlerReadMe.md --gfm > "doc-assets/files/TriggerHandlerHome.html"
+printf '<link href="assets/styling.css" rel="stylesheet" />' >> "doc-assets/files/TriggerHandlerHome.html"
+#rm  "doc-assets/files/triggerHandlerReadMe.md"
+
+curl -L "https://raw.githubusercontent.com/dschach/record-types/main/doc-assets/RecordTypesHome.html" -o "doc-assets/files/RecordTypesHome.html"
+printf '<link href="assets/styling.css" rel="stylesheet" />'  >> "doc-assets/files/RecordTypesHome.html"
+
+npx marked -i doc-assets/files/TestDataFactoryReadMe.md --gfm > "doc-assets/files/TestDataFactoryReadMe.html"
+printf '<link href="assets/styling.css" rel="stylesheet" />'  >> "doc-assets/files/TestDataFactoryReadMe.html"
+
+# npx marked -i doc-assets/main.md --gfm > "doc-assets/main.html"
+
+printf '<link href="assets/styling.css" rel="stylesheet" />' > "doc-assets/main.html"
+echo >> "doc-assets/main.html"
+npx marked -i README.md --gfm >> "doc-assets/main.html"
+
+npm run updateHighlight
diff --git a/doc-assets/updateHighlight.sh b/doc-assets/updateHighlight.sh
diff --git a/docs/CampaignMemberRepository.html b/docs/CampaignMemberRepository.html
@@ -43,9 +43,6 @@
 							<li title="CampaignMemberService" id="item-CampaignMemberService" class="nav-item class public" onclick="goToLocation('CampaignMemberService.html');">
 								<a tabindex="1" href="javascript:void(0)">CampaignMemberService</a>
 							</li>
-							<li title="CampaignMemberServiceTest" id="item-CampaignMemberServiceTest" class="nav-item class private" onclick="goToLocation('CampaignMemberServiceTest.html');">
-								<a tabindex="1" href="javascript:void(0)">CampaignMemberServiceTest</a>
-							</li>
 							<li
 								title="CampaignMemberStatusEventTriggerHandler"
 								id="item-CampaignMemberStatusEventTriggerHandler"
@@ -56,21 +53,46 @@
 							<li title="CampaignMemberStatusJob" id="item-CampaignMemberStatusJob" class="nav-item class public" onclick="goToLocation('CampaignMemberStatusJob.html');">
 								<a tabindex="1" href="javascript:void(0)">CampaignMemberStatusJob</a>
 							</li>
+							<li title="CampaignTriggerHandler" id="item-CampaignTriggerHandler" class="nav-item class public" onclick="goToLocation('CampaignTriggerHandler.html');">
+								<a tabindex="1" href="javascript:void(0)">CampaignTriggerHandler</a>
+							</li>
+						</ul>
+					</details>
+					<details id="CampaignMemberStatusTests" class="group-name">
+						<summary id="header-CampaignMemberStatusTests" class="nav-header">
+							<span>CampaignMemberStatusTests</span>
+						</summary>
+						<ul>
+							<!-- menu items -->
+							<li title="CampaignMemberServiceTest" id="item-CampaignMemberServiceTest" class="nav-item class private" onclick="goToLocation('CampaignMemberServiceTest.html');">
+								<a tabindex="1" href="javascript:void(0)">CampaignMemberServiceTest</a>
+							</li>
 							<li
 								title="CampaignMemberStatusJobTest"
 								id="item-CampaignMemberStatusJobTest"
 								class="nav-item class private"
 								onclick="goToLocation('CampaignMemberStatusJobTest.html');">
 								<a tabindex="1" href="javascript:void(0)">CampaignMemberStatusJobTest</a>
 							</li>
-							<li title="CampaignTriggerHandler" id="item-CampaignTriggerHandler" class="nav-item class public" onclick="goToLocation('CampaignTriggerHandler.html');">
-								<a tabindex="1" href="javascript:void(0)">CampaignTriggerHandler</a>
-							</li>
 							<li title="CampaignTriggerTest" id="item-CampaignTriggerTest" class="nav-item class private" onclick="goToLocation('CampaignTriggerTest.html');">
 								<a tabindex="1" href="javascript:void(0)">CampaignTriggerTest</a>
 							</li>
 						</ul>
 					</details>
+					<details id="Trigger_Handler_Framework" class="group-name">
+						<summary id="header-Trigger_Handler_Framework" class="nav-header">
+							<span>Trigger Handler Framework</span>
+						</summary>
+						<ul>
+							<!-- menu items -->
+							<li title="TriggerHandler" id="item-TriggerHandler" class="nav-item class public" onclick="goToLocation('TriggerHandler.html');">
+								<a tabindex="1" href="javascript:void(0)">TriggerHandler</a>
+							</li>
+							<li title="TriggerHandlerTest" id="item-TriggerHandlerTest" class="nav-item class private" onclick="goToLocation('TriggerHandlerTest.html');">
+								<a tabindex="1" href="javascript:void(0)">TriggerHandlerTest</a>
+							</li>
+						</ul>
+					</details>
 				</nav>
 			</div>
 		</div>
@@ -109,7 +131,12 @@ <h2 class="class-title top-level-type" id="CampaignMemberRepository">
 							<div class="class-subtitle">Signature</div>
 
 							<div class="class-signature">public without sharing virtual class CampaignMemberRepository</div>
-							<br />Sercante LLC<br />2022
+							<div class="class-subtitle">Author</div>
+							<div class="class-subtitle-description">Sercante LLC</div>
+							<div class="class-subtitle">Since</div>
+							<div class="class-subtitle-description">
+								<li>2022</li>
+							</div>
 						</div>
 						<div class="subsection methods">
 							<h3 class="subsection-title methods">CampaignMemberRepository Methods</h3>

diff --git a/docs/CampaignMemberService.html b/docs/CampaignMemberService.html
@@ -43,9 +43,6 @@
 							<li title="CampaignMemberService" id="item-CampaignMemberService" class="nav-item class public" onclick="goToLocation('CampaignMemberService.html');">
 								<a tabindex="1" href="javascript:void(0)">CampaignMemberService</a>
 							</li>
-							<li title="CampaignMemberServiceTest" id="item-CampaignMemberServiceTest" class="nav-item class private" onclick="goToLocation('CampaignMemberServiceTest.html');">
-								<a tabindex="1" href="javascript:void(0)">CampaignMemberServiceTest</a>
-							</li>
 							<li
 								title="CampaignMemberStatusEventTriggerHandler"
 								id="item-CampaignMemberStatusEventTriggerHandler"
@@ -56,21 +53,46 @@
 							<li title="CampaignMemberStatusJob" id="item-CampaignMemberStatusJob" class="nav-item class public" onclick="goToLocation('CampaignMemberStatusJob.html');">
 								<a tabindex="1" href="javascript:void(0)">CampaignMemberStatusJob</a>
 							</li>
+							<li title="CampaignTriggerHandler" id="item-CampaignTriggerHandler" class="nav-item class public" onclick="goToLocation('CampaignTriggerHandler.html');">
+								<a tabindex="1" href="javascript:void(0)">CampaignTriggerHandler</a>
+							</li>
+						</ul>
+					</details>
+					<details id="CampaignMemberStatusTests" class="group-name">
+						<summary id="header-CampaignMemberStatusTests" class="nav-header">
+							<span>CampaignMemberStatusTests</span>
+						</summary>
+						<ul>
+							<!-- menu items -->
+							<li title="CampaignMemberServiceTest" id="item-CampaignMemberServiceTest" class="nav-item class private" onclick="goToLocation('CampaignMemberServiceTest.html');">
+								<a tabindex="1" href="javascript:void(0)">CampaignMemberServiceTest</a>
+							</li>
 							<li
 								title="CampaignMemberStatusJobTest"
 								id="item-CampaignMemberStatusJobTest"
 								class="nav-item class private"
 								onclick="goToLocation('CampaignMemberStatusJobTest.html');">
 								<a tabindex="1" href="javascript:void(0)">CampaignMemberStatusJobTest</a>
 							</li>
-							<li title="CampaignTriggerHandler" id="item-CampaignTriggerHandler" class="nav-item class public" onclick="goToLocation('CampaignTriggerHandler.html');">
-								<a tabindex="1" href="javascript:void(0)">CampaignTriggerHandler</a>
-							</li>
 							<li title="CampaignTriggerTest" id="item-CampaignTriggerTest" class="nav-item class private" onclick="goToLocation('CampaignTriggerTest.html');">
 								<a tabindex="1" href="javascript:void(0)">CampaignTriggerTest</a>
 							</li>
 						</ul>
 					</details>
+					<details id="Trigger_Handler_Framework" class="group-name">
+						<summary id="header-Trigger_Handler_Framework" class="nav-header">
+							<span>Trigger Handler Framework</span>
+						</summary>
+						<ul>
+							<!-- menu items -->
+							<li title="TriggerHandler" id="item-TriggerHandler" class="nav-item class public" onclick="goToLocation('TriggerHandler.html');">
+								<a tabindex="1" href="javascript:void(0)">TriggerHandler</a>
+							</li>
+							<li title="TriggerHandlerTest" id="item-TriggerHandlerTest" class="nav-item class private" onclick="goToLocation('TriggerHandlerTest.html');">
+								<a tabindex="1" href="javascript:void(0)">TriggerHandlerTest</a>
+							</li>
+						</ul>
+					</details>
 				</nav>
 			</div>
 		</div>
@@ -109,7 +131,12 @@ <h2 class="class-title top-level-type" id="CampaignMemberService">
 							<div class="class-subtitle">Signature</div>
 
 							<div class="class-signature">public virtual without sharing class CampaignMemberService</div>
-							<br />Sercante LLC<br />2022
+							<div class="class-subtitle">Author</div>
+							<div class="class-subtitle-description">Sercante LLC</div>
+							<div class="class-subtitle">Since</div>
+							<div class="class-subtitle-description">
+								<li>2022</li>
+							</div>
 						</div>
 						<div class="subsection properties CampaignMemberService">
 							<h3 class="subsection-title properties">CampaignMemberService Properties</h3>
@@ -188,7 +215,7 @@ <h4 class="method-title" id="CampaignMemberService.enforceProtectedStatusesForCa
 											rel="noopener noreferrer"
 											title="Go to source"
 											class="source-link"
-											href="https://github.com/dschach/campaign-member-status/CampaignMemberService.cls#L96">
+											href="https://github.com/dschach/campaign-member-status/CampaignMemberService.cls#L92">
 											enforceProtectedStatusesForCampaigns(campaignIds)
 										</a>
 									</h4>
@@ -203,7 +230,7 @@ <h4 class="method-title" id="CampaignMemberService.getCampaignsNeedingToBeFixed"
 											rel="noopener noreferrer"
 											title="Go to source"
 											class="source-link"
-											href="https://github.com/dschach/campaign-member-status/CampaignMemberService.cls#L61">
+											href="https://github.com/dschach/campaign-member-status/CampaignMemberService.cls#L57">
 											getCampaignsNeedingToBeFixed()
 										</a>
 									</h4>
@@ -221,7 +248,7 @@ <h4 class="method-title" id="CampaignMemberService.getCampaignsWithMemberStatuse
 											rel="noopener noreferrer"
 											title="Go to source"
 											class="source-link"
-											href="https://github.com/dschach/campaign-member-status/CampaignMemberService.cls#L35">
+											href="https://github.com/dschach/campaign-member-status/CampaignMemberService.cls#L31">
 											getCampaignsWithMemberStatuses(campaignIds)
 										</a>
 									</h4>
@@ -236,7 +263,7 @@ <h4 class="method-title" id="CampaignMemberService.getGroupedProtectedStatuses">
 											rel="noopener noreferrer"
 											title="Go to source"
 											class="source-link"
-											href="https://github.com/dschach/campaign-member-status/CampaignMemberService.cls#L51">
+											href="https://github.com/dschach/campaign-member-status/CampaignMemberService.cls#L47">
 											getGroupedProtectedStatuses()
 										</a>
 									</h4>

diff --git a/docs/CampaignMemberServiceTest.html b/docs/CampaignMemberServiceTest.html
@@ -43,9 +43,6 @@
 							<li title="CampaignMemberService" id="item-CampaignMemberService" class="nav-item class public" onclick="goToLocation('CampaignMemberService.html');">
 								<a tabindex="1" href="javascript:void(0)">CampaignMemberService</a>
 							</li>
-							<li title="CampaignMemberServiceTest" id="item-CampaignMemberServiceTest" class="nav-item class private" onclick="goToLocation('CampaignMemberServiceTest.html');">
-								<a tabindex="1" href="javascript:void(0)">CampaignMemberServiceTest</a>
-							</li>
 							<li
 								title="CampaignMemberStatusEventTriggerHandler"
 								id="item-CampaignMemberStatusEventTriggerHandler"
@@ -56,21 +53,46 @@
 							<li title="CampaignMemberStatusJob" id="item-CampaignMemberStatusJob" class="nav-item class public" onclick="goToLocation('CampaignMemberStatusJob.html');">
 								<a tabindex="1" href="javascript:void(0)">CampaignMemberStatusJob</a>
 							</li>
+							<li title="CampaignTriggerHandler" id="item-CampaignTriggerHandler" class="nav-item class public" onclick="goToLocation('CampaignTriggerHandler.html');">
+								<a tabindex="1" href="javascript:void(0)">CampaignTriggerHandler</a>
+							</li>
+						</ul>
+					</details>
+					<details id="CampaignMemberStatusTests" class="group-name">
+						<summary id="header-CampaignMemberStatusTests" class="nav-header">
+							<span>CampaignMemberStatusTests</span>
+						</summary>
+						<ul>
+							<!-- menu items -->
+							<li title="CampaignMemberServiceTest" id="item-CampaignMemberServiceTest" class="nav-item class private" onclick="goToLocation('CampaignMemberServiceTest.html');">
+								<a tabindex="1" href="javascript:void(0)">CampaignMemberServiceTest</a>
+							</li>
 							<li
 								title="CampaignMemberStatusJobTest"
 								id="item-CampaignMemberStatusJobTest"
 								class="nav-item class private"
 								onclick="goToLocation('CampaignMemberStatusJobTest.html');">
 								<a tabindex="1" href="javascript:void(0)">CampaignMemberStatusJobTest</a>
 							</li>
-							<li title="CampaignTriggerHandler" id="item-CampaignTriggerHandler" class="nav-item class public" onclick="goToLocation('CampaignTriggerHandler.html');">
-								<a tabindex="1" href="javascript:void(0)">CampaignTriggerHandler</a>
-							</li>
 							<li title="CampaignTriggerTest" id="item-CampaignTriggerTest" class="nav-item class private" onclick="goToLocation('CampaignTriggerTest.html');">
 								<a tabindex="1" href="javascript:void(0)">CampaignTriggerTest</a>
 							</li>
 						</ul>
 					</details>
+					<details id="Trigger_Handler_Framework" class="group-name">
+						<summary id="header-Trigger_Handler_Framework" class="nav-header">
+							<span>Trigger Handler Framework</span>
+						</summary>
+						<ul>
+							<!-- menu items -->
+							<li title="TriggerHandler" id="item-TriggerHandler" class="nav-item class public" onclick="goToLocation('TriggerHandler.html');">
+								<a tabindex="1" href="javascript:void(0)">TriggerHandler</a>
+							</li>
+							<li title="TriggerHandlerTest" id="item-TriggerHandlerTest" class="nav-item class private" onclick="goToLocation('TriggerHandlerTest.html');">
+								<a tabindex="1" href="javascript:void(0)">TriggerHandlerTest</a>
+							</li>
+						</ul>
+					</details>
 				</nav>
 			</div>
 		</div>
@@ -105,10 +127,16 @@ <h2 class="class-title top-level-type" id="CampaignMemberServiceTest">
 							</a>
 						</h2>
 						<div class="class-container">
+							<div class="class-description">Test class</div>
 							<div class="class-subtitle">Signature</div>
 							<div class="class-annotations">@isTest</div>
 							<div class="class-signature">private class CampaignMemberServiceTest</div>
-							<br />Sercante LLC<br />2022
+							<div class="class-subtitle">Author</div>
+							<div class="class-subtitle-description">Sercante LLC</div>
+							<div class="class-subtitle">Since</div>
+							<div class="class-subtitle-description">
+								<li>2022</li>
+							</div>
 						</div>
 						<div class="subsection methods">
 							<h3 class="subsection-title methods">CampaignMemberServiceTest Methods</h3>