Update release documentation

ETCLabs · Aug 18, 2020 · 805b041 · 805b041
1 parent f3b4a4a
commit 805b041
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 10 deletions.
diff --git a/docs/etcpal.tag b/docs/etcpal.tag
@@ -2036,8 +2036,8 @@
       <type>bool</type>
       <name>Send</name>
       <anchorfile>classetcpal_1_1_queue.html</anchorfile>
-      <anchor>aa5e74f70881c76ee779a05d7c0a0283e</anchor>
-      <arglist>(const T &amp;data, int timeout_ms=0)</arglist>
+      <anchor>ad23735bc801c21635a277a31ac31b267</anchor>
+      <arglist>(const T &amp;data, int timeout_ms=ETCPAL_WAIT_FOREVER)</arglist>
     </member>
     <member kind="function">
       <type>bool</type>
@@ -2050,15 +2050,15 @@
       <type>bool</type>
       <name>Receive</name>
       <anchorfile>classetcpal_1_1_queue.html</anchorfile>
-      <anchor>a1e05b9a1beab8065c28062e2a91d4cf7</anchor>
-      <arglist>(T &amp;data, int timeout_ms=0)</arglist>
+      <anchor>ae2bd22bccd067e5b8558810eb878f7bf</anchor>
+      <arglist>(T &amp;data, int timeout_ms=ETCPAL_WAIT_FOREVER)</arglist>
     </member>
     <member kind="function">
       <type>bool</type>
       <name>Receive</name>
       <anchorfile>classetcpal_1_1_queue.html</anchorfile>
-      <anchor>ad9261100b606a1dc7f096a813987fcfd</anchor>
-      <arglist>(T &amp;data, const std::chrono::duration&lt; Rep, Period &gt; &amp;timeout=std::chrono::milliseconds(0))</arglist>
+      <anchor>a2e1a4a59421e30ad677c4aab766a6683</anchor>
+      <arglist>(T &amp;data, const std::chrono::duration&lt; Rep, Period &gt; &amp;timeout)</arglist>
     </member>
     <member kind="function">
       <type>bool</type>
@@ -4960,6 +4960,20 @@
       <anchor>gad093318703094fd4bdb9ecb09443241d</anchor>
       <arglist>(EtcPalRbIter *self)</arglist>
     </member>
+    <member kind="function">
+      <type>void *</type>
+      <name>etcpal_rbiter_lower_bound</name>
+      <anchorfile>group__etcpal__rbtree.html</anchorfile>
+      <anchor>ga44f891bf17cabdfba6bf7748c02fe52b</anchor>
+      <arglist>(EtcPalRbIter *self, EtcPalRbTree *tree, const void *value)</arglist>
+    </member>
+    <member kind="function">
+      <type>void *</type>
+      <name>etcpal_rbiter_upper_bound</name>
+      <anchorfile>group__etcpal__rbtree.html</anchorfile>
+      <anchor>ga260091c3e633a8b5e3db3625e615032d</anchor>
+      <arglist>(EtcPalRbIter *self, EtcPalRbTree *tree, const void *value)</arglist>
+    </member>
     <member kind="typedef">
       <type>int(*</type>
       <name>EtcPalRbTreeNodeCmpFunc</name>

diff --git a/docs/generate_doxygen.py b/docs/generate_doxygen.py
@@ -1,10 +1,15 @@
+import argparse
 import os
 import re
 import shutil
 import subprocess
 import sys
 import time
 
+parser = argparse.ArgumentParser(description="Generate the EtcPal documentation")
+parser.add_argument("-r", "--release", help="The release number that this documentation is being generated for.")
+args = parser.parse_args()
+
 THIS_SCRIPT_DIRECTORY = os.path.dirname(os.path.realpath(__file__))
 
 print("Generating Doxygen and capturing warnings...")
@@ -17,6 +22,10 @@
         os.getenv("GH_REPO_NAME", "EtcPal"),
         os.getenv("SYSTEM_PULLREQUEST_PULLREQUESTNUMBER"),
     )
+elif args.release:
+    project_number = args.release
+    (vers_maj, vers_min, _) = args.release.split(".")
+    output_dir = "build/{}/docs/v{}".format(os.getenv("GH_REPO_NAME", "EtcPal"), f"{vers_maj}.{vers_min}")
 else:
     project_number = "HEAD (unstable)"
     output_dir = "build/{}/docs/head".format(os.getenv("GH_REPO_NAME", "EtcPal"))

diff --git a/tools/version/release_checklist.md b/tools/version/release_checklist.md
@@ -6,11 +6,9 @@
 - [ ] Check `ThirdPartySoftware.txt` to make sure it is still accurate and doesn't need any
       additions
 - [ ] Generate docs for the version
-  * Follow `tools/ci/publish_docs.sh` manually, except replace "head" with version number in the
-    form "vM.m"
+  * Follow `tools/ci/publish_docs.sh` manually, except do `python generate_doxygen.py -r [3-digit release number]`
   * Add the version number to `versions.txt` on the `gh-pages` branch and mark it as latest
-  * `PROJECT_NUMBER` in the Doxyfile should be correct but might need to be updated for patch
-    versions
+  * Prune any unused stage/ directories on the `gh-pages` branch.
   * Commit the updated `etcpal.tag` file on the current branch (`develop` or `release/v*`)
 - [ ] Merge changes to `stable`
   * `git checkout stable`