Skip to content

Commit

Permalink
Documentation enhancements
Browse files Browse the repository at this point in the history
  • Loading branch information
@warent
warent committed Jun 9, 2024
1 parent 288525f commit e3eaae0
Show file tree
Hide file tree
Showing 728 changed files with 4,725 additions and 21,714 deletions.
2 changes: 1 addition & 1 deletion Documentation/ContentLayout.content
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<Topics>
<Topic id="70fe4854-e3f3-4319-8e68-672dc540db0b" visible="True" isDefault="true" isSelected="true" title="HLNC Documentation">
<Topic id="70fe4854-e3f3-4319-8e68-672dc540db0b" visible="True" isDefault="true" isSelected="true" title="Welcome">
<HelpKeywords>
<HelpKeyword index="K" term="Welcome" />
</HelpKeywords>
Expand Down
26 changes: 19 additions & 7 deletions Documentation/Documentation.shfbproj
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
<Argument Key="maxVersionParts" Value="" xmlns="" />
</TransformComponentArguments>
<HelpFileFormat>Website</HelpFileFormat>
<SyntaxFilters>Standard</SyntaxFilters>
<SyntaxFilters>C#</SyntaxFilters>
<PresentationStyle>Default2022</PresentationStyle>
<CleanIntermediates>False</CleanIntermediates>
<KeepLogFile>True</KeepLogFile>
Expand All @@ -45,14 +45,26 @@
<PlugInConfigurations>
<PlugInConfig id="XPath Reflection File Filter" enabled="True">
<configuration>
<expressions>
<expression>/reflection/apis/api/elements/element[contains(@api,"PropertyName")]</expression>
<expression>/reflection/apis/api/elements/element[contains(@api,"SignalName")]</expression>
<expression>/reflection/apis/api/elements/element[contains(@api,"MethodName")]</expression>
</expressions>
</configuration>
<expressions>
<expression>/reflection/apis/api/elements/element[contains(@api,"PropertyName")]</expression>
<expression>/reflection/apis/api/elements/element[contains(@api,"SignalName")]</expression>
<expression>/reflection/apis/api/elements/element[contains(@api,"MethodName")]</expression>
</expressions>
</configuration>
</PlugInConfig>
</PlugInConfigurations>
<HelpTitle>HLNC Documentation</HelpTitle>
<HelpFileVersion>1.0.0.0</HelpFileVersion>
<NamingMethod>MemberName</NamingMethod>
<ContentPlacement>AboveNamespaces</ContentPlacement>
<RootNamespaceContainer>False</RootNamespaceContainer>
<NamespaceGrouping>False</NamespaceGrouping>
<MaximumGroupParts>2</MaximumGroupParts>
<Preliminary>False</Preliminary>
<SdkLinkTarget>Blank</SdkLinkTarget>
<CopyrightHref>https://raw.githubusercontent.com/Heavenlode/HLNC/main/LICENSE</CopyrightHref>
<CopyrightText>MIT Licensed</CopyrightText>
<VisibleItems>Protected, ProtectedInternalAsProtected, NonBrowsable</VisibleItems>
</PropertyGroup>
<!-- There are no properties for these groups. AnyCPU needs to appear in order for Visual Studio to perform
the build. The others are optional common platform types that may appear. -->
Expand Down
4 changes: 2 additions & 2 deletions Documentation/Help/GeneralError.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@
<link rel="stylesheet" href="css/presentationStyle.css" />
<script src="scripts/jquery-3.5.1.min.js"></script>
<script src="scripts/presentationStyle.js"></script>
<title>A Sandcastle Documented Class Library - General Error</title>
<title>HLNC Documentation - General Error</title>
</head>

<body>
<section id="MainSection" class="section p-0">
<div class="pageHeader level mb-2 pt-2 pb-2 pl-5 pr-5">
<div id="TitleContainer" class="level-left">
<div id="DocumentationTitle" class="level-item">
A Sandcastle Documented Class Library - General Error
HLNC Documentation - General Error
</div>
</div>
</div>
Expand Down
11,914 changes: 39 additions & 11,875 deletions Documentation/Help/LastBuild.log
View file

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions Documentation/Help/PageNotFound.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@
<link rel="stylesheet" href="css/presentationStyle.css" />
<script src="scripts/jquery-3.5.1.min.js"></script>
<script src="scripts/presentationStyle.js"></script>
<title>A Sandcastle Documented Class Library - Page Not Found</title>
<title>HLNC Documentation - Page Not Found</title>
</head>

<body>
<section id="MainSection" class="section p-0">
<div class="pageHeader level mb-2 pt-2 pb-2 pl-5 pr-5">
<div id="TitleContainer" class="level-left">
<div id="DocumentationTitle" class="level-item">
A Sandcastle Documented Class Library - Page Not Found
HLNC Documentation - Page Not Found
</div>
</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion Documentation/Help/fti/FTI_100.json
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion Documentation/Help/fti/FTI_101.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"exclude":[21430273,21495809,21561345,21626881,21692417,21757953,21823489,21889025,21954561,22020097,22085633,22216705],"emitsignal":[21430278,21561350,21495814,21626886,21692422,21757958,21823494,21889030,21954566,22020102,22085638,22216710],"emitting":[21430274,21495810,21561346,21626882,21692418,21757954,21823490,21889026,21954562,22020098,22085634,22216706],"expressions":[21430273,21495809,21561345,21626881,21692417,21757953,21823489,21889025,21954561,22020097,22085633,22216705],"elapsed":[21430274,21561346,21495810,21626882,21692418,21757954,21823490,21889026,21954562,22020098,22085634,22216706],"exposed":[21430286,21495822,21561358,21626894,21692430,21757966,21823502,21889038,21954574,22020110,22085646,22216718],"existing":[8781825,11010049,16646145,20971521,21168129,21364737,21430277,21561350,21495813,21626885,21692421,21757957,21823493,21889030,21954566,22020102,22085638,22216710],"excludes":[21430273,21495809,21561345,21626881,21692417,21757953,21823489,21889025,21954561,22020097,22085633,22216705],"exact":[21430274,21495810,21561346,21626882,21692418,21757954,21823490,21889026,21954562,22020098,22085634,22216706],"entered":[2097153,5963777,14090241,16252929,18939905,19333121,21561345,21757953,21823489,21889026,21954561,22020097,22085633,22216706],"expects":[21430273,21495809,21561345,21626881,21692417,21757953,21823489,21889025,21954561,22020097,22085633,22216705],"exist":[21430279,21561351,21495815,21626887,21692423,21757959,21823495,21889031,21954567,22020103,22085639,22216711],"energy":[21430276,21495812,21561348,21626884,21692420,21757956,21823492,21889028,21954564,22020100,22085636,22216708],"essentially":[8781825,16646145,21168129,21364737,21889025,21954561,22020097,22085633],"export_group":[21430273,21495809,21561345,21626881,21692417,21757953,21823489,21889025,21954561,22020097,22085633,22216705],"editordescriptionchanged":[2097153,5963777,14090241,16252929,18939905,19333121,21561345,21889025,21954561,22020097,22085633,22216705],"editable":[21430274,21495810,21561346,21626882,21692418,21757954,21823490,21889026,21954562,22020098,22085634,22216706],"explorer":[9371649],"enumerations":[9699330],"exported":[9109505,21430273,21495809,21561345,21626881,21692417,21757953,21823489,21889025,21954561,22020097,22085633,22216705],"examples":[21430279,21495815,21561351,21626887,21692423,21757959,21823495,21889031,21954567,22020103,22085639,22216711],"editordescription":[8781825,11010049,16646145,20971521,21168129,21364737,21561345,21889025,21954561,22020097,22085633,22216705],"earlier":[21757953,21823489,21889025,22216705],"element":[21430275,21495811,21561347,21626883,21692419,21757955,21823491,21889027,21954563,22020099,22085635,22216707],"events":[2097155,5963779,14090243,16252931,18939907,19333123,21430281,21495817,21561355,21626889,21692425,21757961,21823497,21889035,21954571,22020107,22085643,22216715],"exits":[2097153,5963777,14090241,16252929,18939905,19333121,21561345,21889025,21954561,22020097,22085633,22216705],"enumeration":[1310722,20643842],"enabled":[21430296,21495832,21561368,21626904,21692440,21757977,21823513,21889049,21954584,22020120,22085656,22216729],"enables":[21430282,21495817,21561353,21626890,21692426,21757961,21823498,21889034,21954570,22020106,22085642,22216713],"enetmultiplayerpeer":[16973829],"equals":[655361,1048577,1179649,1900545,3538945,4587521,4980737,5046273,5636097,6029313,6160385,6815746,7143425,7012354,7274497,7340033,7536641,8388609,8519681,8650753,8978434,9306113,9502721,9633793,9764865,10223617,11599873,12124161,12255233,12648449,12713985,13041665,13369345,13828097,13893633,14024705,14417922,15204353,15597569,16842753,18546689,18612225,19005441,19070977,19464193,20905985,21430273,21495809,21561345,21626881,21692417,21757953,21823489,21889025,21954561,22020097,22085633,22216705],"export_enum":[21430273,21495809,21561345,21626881,21692417,21757953,21823489,21889025,21954561,22020097,22085633,22216705],"equal":[655361,1048577,1179649,1900545,3538945,4587521,4980737,5046273,5636097,6029313,6160385,6815745,7143425,7012353,7274497,7340033,7536641,8388609,8519681,8650753,8978433,9306113,9502721,9633793,9764865,10223617,11599873,12124161,12255233,12648449,12713985,13041665,13369345,13828097,13893633,14024705,14417921,15204353,15597569,16842753,18546689,18612225,19005441,19070977,19464193,20905985,21430273,21495809,21561345,21626881,21692417,21757953,21823489,21889025,21954561,22020097,22085633,22216705],"enters":[2097154,5963778,14090242,16252930,18939906,19333122,21430274,21495809,21561347,21626882,21692418,21757954,21823489,21889027,21954564,22020100,22085636,22216708],"exiting":[2097153,5963777,14090241,16252929,18939905,19333121,21561345,21889025,21954561,22020097,22085633,22216705],"extend":[21430273,21561345,21495809,21626881,21692417,21757953,21823489,21889025,21954561,22020097,22085633,22216705],"enter":[21430273,21561345,21495809,21626881,21692417,21757953,21823489,21889025,21954561,22020097,22085633,22216705],"engine":[21430275,21495811,21561347,21626883,21692419,21757956,21823491,21889027,21954563,22020099,22085635,22216708],"emitted":[2097172,5963795,14090260,16252948,18939923,19333140,21430273,21495809,21561364,21626881,21692417,21757953,21823489,21889045,21954581,22020117,22085653,22216724],"easier":[21430273,21495809,21561345,21626881,21692417,21757953,21823489,21889025,21954561,22020097,22085633,22216705],"error":[3,8781825,11010049,16646145,20971521,21168129,21364737,21430283,21561356,21495819,21626891,21692427,21757963,21823499,21889036,21954572,22020108,22085644,22216716],"end":[1048577,1900545,2883585,3538945,3670017,4980737,5046273,6160385,7012353,7274497,8519681,8650753,9306113,9502721,9633793,9764865,10223617,12124161,12845057,13041665,13107201,13369345,13828097,13893633,14417921,16515073,18677761,19070977,20905985,21430277,21561350,21495813,21626885,21692421,21757957,21823493,21889030,21954566,22020102,22085638,22216710],"eventargs":[5308423,13959169,18415617],"entire":[21430273,21495809,21561345,21626881,21692417,21757953,21823489,21889025,21954561,22020097,22085633,22216705],"emits":[21430275,21495811,21561347,21626883,21692419,21757955,21823491,21889027,21954563,22020099,22085635,22216707],"edited":[8781825,16646145,21168129,21364737,21430277,21561349,21495813,21626885,21692421,21757957,21823493,21889030,21954566,22020102,22085638,22216709],"example":[8781826,11010049,16646146,20971521,21168130,21364738,21430280,21495816,21561353,21626888,21692424,21757960,21823496,21889034,21954570,22020106,22085642,22216713],"exit":[2097154,5963778,14090242,16252930,18939906,19333122,21561346,21889026,21954562,22020098,22085634,22216706],"enemies":[21430273,21495809,21561345,21626881,21692417,21757953,21823489,21889025,21954561,22020097,22085633,22216705],"encodedobjectasid":[21430273,21561345,21495809,21626881,21692417,21757953,21823489,21889025,21954561,22020097,22085633,22216705],"event":[5308417,5439489,8454145,13959172,18415620,20774916,21430281,21495817,21561353,21626889,21692425,21757961,21823497,21889033,21954569,22020105,22085641,22216713],"enum":[1310722,20643842,21430273,21495809,21561345,21626881,21692417,21757953,21823489,21889025,21954561,22020097,22085633,22216705],"empty":[21430278,21495814,21561350,21626886,21692422,21757958,21823494,21889030,21954566,22020102,22085638,22216710],"enabling":[8781825,11010049,16646145,20971521,21168129,21364737,21561345,21889025,21954561,22020097,22085633,22216705],"elements":[9371649,21430273,21495809,21561345,21626881,21692417,21757953,21823489,21889025,21954561,22020097,22085633,22216705],"entry":[21430279,21561351,21495815,21626887,21692423,21757959,21823495,21889031,21954567,22020103,22085639,22216711],"effect":[21430273,21561345,21495809,21626881,21692417,21757953,21823489,21889025,21954561,22020097,22085633,22216705],"editor":[2097153,5963777,8781826,9371649,11010049,14090241,16252929,16646146,18939905,19333121,20971521,21168130,21364738,21430297,21495827,21561365,21626905,21692441,21757971,21823513,21889052,21954588,22020124,22085660,22216725],"euler":[8781831,16646151,21168135,21364743,21889031,21954567,22020103,22085639],"execution":[8781825,11010049,16646145,20971521,21168129,21364737,21561345,21889025,21954561,22020097,22085633,22216705],"ensures":[21430273,21495809,21561345,21626881,21692417,21757953,21823489,21889025,21954561,22020097,22085633,22216705],"explicitly":[21430273,21495809,21561345,21626881,21692417,21757953,21823489,21889025,21954561,22020097,22085633,22216705],"entries":[21430279,21495815,21561351,21626887,21692423,21757959,21823495,21889031,21954567,22020103,22085639,22216711],"emit":[21430274,21561346,21495810,21626882,21692418,21757954,21823490,21889026,21954562,22020098,22085634,22216706],"equivalent":[8781827,16646147,21168131,21364739,21430277,21495812,21561348,21626885,21692421,21757956,21823493,21889032,21954568,22020104,22085640,22216708],"exists":[8781826,16646146,21168130,21364738,21430283,21561354,21495818,21626891,21692427,21757964,21823500,21889038,21954573,22020109,22085645,22216716],"export":[3604489,16515073,17825793,21430277,21495813,21561349,21626885,21692421,21757957,21823493,21889029,21954565,22020101,22085637,22216709],"exclusive":[21430273,21561345,21495809,21626881,21692417,21757953,21823489,21889025,21954561,22020097,22085633,22216705],"edito":[8781825,11010049,16646145,20971521,21168129,21364737,21430273,21561346,21495809,21626881,21692417,21757953,21823489,21889026,21954562,22020098,22085634,22216706],"endtick":[17498118]}
{"editor":[1048577],"endtick":[15794179],"error":[3],"export":[10027009,12648454,18743297],"enetmultiplayerpeer":[3473410],"enumerations":[14286850],"enum":[18219009,19595265],"exported":[8585217],"event":[655362,720898,1114114,8323073,16187393,16711681],"eventargs":[8323075],"elements":[1048577],"end":[15204353],"explorer":[1048577],"enumeration":[18219009,19595265],"events":[327683,786435,17235970,20054018]}
Loading

0 comments on commit e3eaae0

Please sign in to comment.