Merge pull request #299 from AsherGlick/adding_more_examples

Adding more examples to the documentation
AsherGlick · May 26, 2024 · 21333c0 · 21333c0
2 parents d5f02a2 + 53618cb
commit 21333c0
Show file tree

Hide file tree

Showing 12 changed files with 635 additions and 2 deletions.
diff --git a/xml_converter/doc/acheivement/achievement_id.md b/xml_converter/doc/acheivement/achievement_id.md
@@ -4,6 +4,8 @@ type: Int32
 applies_to: [Icon, Trail]
 xml_fields: ["AchievementId"]
 protobuf_field: achievement_id
+examples:
+  - "2655"
 ---
 An achivement that, if completed, will hide this marker
 

diff --git a/xml_converter/doc/category/category.md b/xml_converter/doc/category/category.md
@@ -5,6 +5,10 @@ class: MarkerCategory
 applies_to: [Icon, Trail]
 xml_fields: [Type, Category]
 protobuf_field: category
+examples:
+  - "mycategory"
+  - "mycategory.subcategory"
+  - "mycategory.subcategory.subsubcategory"
 custom_functions:
   read.proto:
     function: do_nothing

diff --git a/xml_converter/doc/fade/distance_fade_end.md b/xml_converter/doc/fade/distance_fade_end.md
@@ -4,8 +4,13 @@ type: Float32
 applies_to: [Icon, Trail]
 xml_fields: [FadeFar, DistanceFadeEnd]
 protobuf_field: distance_fade_end
+examples:
+  - "850"
+  - "600"
+  - "1100"
 ---
 Any part of the object that is farther then this value will be at 0 alpha. 
+Defaults to 900
 
 Notes
 =====

diff --git a/xml_converter/doc/fade/distance_fade_start.md b/xml_converter/doc/fade/distance_fade_start.md
@@ -4,8 +4,13 @@ type: Float32
 applies_to: [Icon, Trail]
 xml_fields: [FadeNear, DistanceFadeStart]
 protobuf_field: distance_fade_start
+examples:
+  - "650"
+  - "400"
+  - "900"
 ---
 Any part of the object that is farther then this value will begin to alpha fade gradually until it reaches 0 alpha at Distance Fade End.
+Defaults to 700
 
 Notes
 =====

diff --git a/xml_converter/doc/map_id/map_id.md b/xml_converter/doc/map_id/map_id.md
@@ -4,6 +4,10 @@ type: Int32
 applies_to: [Icon, Trail]
 xml_fields: [MapID]
 protobuf_field: map_id
+examples:
+  - "24"
+  - "50"
+  - "1509"
 ---
 The Map which this marker should be displayed on.
 

diff --git a/xml_converter/doc/menu/display_name.md b/xml_converter/doc/menu/display_name.md
@@ -4,6 +4,9 @@ type: String
 applies_to: [Category]
 xml_fields: [DisplayName]
 protobuf_field: name
+examples:
+  - "My Category"
+  - "Tribulation Mode 203"
 custom_functions:
   read.proto:
     function: proto_display_name_to_display_name_and_name

diff --git a/xml_converter/doc/menu/menu_id.md b/xml_converter/doc/menu/menu_id.md
@@ -5,6 +5,11 @@ class: UniqueId
 xml_fields: [ID, MenuID]
 applies_to: [Category]
 protobuf_field: id
+examples:
+  - "KOjMBsKTXpY="
+  - "LJKn7WpADjo="
+  - "uJrcuLd4as8="
+  - "cCxU1IXfiKQ="
 ---
 
 Notes

diff --git a/xml_converter/doc/menu/name.md b/xml_converter/doc/menu/name.md
@@ -4,6 +4,9 @@ type: String
 applies_to: [Category]
 xml_fields: [Name]
 protobuf_field: name
+examples:
+  - "mycategory"
+  - "tribulationmode203"
 custom_functions:
   read.proto:
     function: do_nothing

diff --git a/xml_converter/doc/position/height_offset.md b/xml_converter/doc/position/height_offset.md
@@ -4,6 +4,8 @@ type: Float32
 applies_to: ["Icon"]
 xml_fields: ["HeightOffset", "BHHeightOffset"]
 protobuf_field: height_offset
+examples:
+  - "0"
 ---
 A vertical offset of the object from the recorded position.