More documentation.

io7m-com · Dec 8, 2023 · c7728e5 · c7728e5
1 parent e826efc
commit c7728e5
Show file tree

Hide file tree

Showing 3 changed files with 41 additions and 7 deletions.
diff --git a/...ycamore.documentation/src/main/resources/com/io7m/jsycamore/documentation/m-rendering.xml b/...ycamore.documentation/src/main/resources/com/io7m/jsycamore/documentation/m-rendering.xml
@@ -4,8 +4,17 @@
          id="703f1dc9-6f1d-4083-a40d-8f7779d1c49b"
          title="Rendering">
 
-  <Paragraph>
-    Rendering...
-  </Paragraph>
+  <Subsection title="Description">
+    <Paragraph>
+      Rendering...
+    </Paragraph>
+  </Subsection>
+
+  <Subsection title="Render Nodes"
+              id="7e859c7f-5516-42fa-8891-0dd15dea5a40">
+    <Paragraph>
+      Render nodes...
+    </Paragraph>
+  </Subsection>
 
 </Section>
diff --git a/...m.jsycamore.documentation/src/main/resources/com/io7m/jsycamore/documentation/m-theme.xml b/...m.jsycamore.documentation/src/main/resources/com/io7m/jsycamore/documentation/m-theme.xml
@@ -4,8 +4,33 @@
          id="6aeefd35-8837-4503-99ee-3ccba984a49e"
          title="Themes">
 
-  <Paragraph>
-    A theme...
-  </Paragraph>
+  <Subsection title="Description">
+    <Paragraph>
+      A <Term type="term">theme</Term> is an entity responsible for deciding the visual appearance of
+      <Link target="cb46abcd-d0b1-41f4-bb95-662186d4aa78">windows</Link> and
+      <Link target="0c480fad-ee66-4532-a0b1-f06ebe582ea8">components</Link>. Primarily, themes can be considered to be
+      functions from components to sets of <Link target="703f1dc9-6f1d-4083-a40d-8f7779d1c49b">render nodes</Link>,
+      although they do have some other responsibilities with regard to
+      <Link target="47130fb1-8639-4950-8743-0bb3ce4755bf">window components</Link>.
+    </Paragraph>
+  </Subsection>
+
+  <Subsection title="Window Components"
+              id="47130fb1-8639-4950-8743-0bb3ce4755bf">
+    <Paragraph>
+      <Link target="cb46abcd-d0b1-41f4-bb95-662186d4aa78">Windows</Link> come with a set of predefined
+      decoration
+      <Link target="f7a815af-b097-4429-90d7-eb8d96e8ec07">components</Link>. Themes are responsible for deciding,
+      given a set of
+      <Link target="88d61172-40fe-4f21-b4e9-776ff4a8f0d7">layout constraints</Link>, where each of these components
+      are to be placed within the constraints.
+    </Paragraph>
+  </Subsection>
+
+  <Subsection title="Components">
+    <Paragraph>
+      Components...
+    </Paragraph>
+  </Subsection>
 
 </Section>
diff --git a/....jsycamore.documentation/src/main/resources/com/io7m/jsycamore/documentation/m-window.xml b/....jsycamore.documentation/src/main/resources/com/io7m/jsycamore/documentation/m-window.xml
@@ -83,7 +83,7 @@
     </Subsection>
   </Section>
 
-  <Section title="Window Decorations">
+  <Section title="Window Decorations" id="f7a815af-b097-4429-90d7-eb8d96e8ec07">
     <Subsection title="Standard Components">
       <Paragraph>
         Windows are created with a standard set of attached components. These standard components allow users to perform