docs: Add version information to configObject and configOption XML elements

Most of the configObjects and configOptions that are implemented with
ACO or Sorcery now have `<since>/<version>` elements added.  There are
probably some that the script I used didn't catch.  The version tags were
determined by the following...
 * Do a git blame on the API call that created the object or option.
 * From the commit hash, grab the summary line.
 * Do a `git log --grep <summary>` to find the cherry-pick commits in all
   branches that match.
 * Do a `git patch-id` to ensure the commits are all related and didn't get
   a false match on the summary.
 * Do a `git tag --contains <commit>` to find the tags that contain each
   commit.
 * Weed out all tags not <major>.<minor>.0.
 * Sort and discard any <major>.0.0 and following tags where the commit
   appeared in an earlier branch.
 * The result is a single tag for each branch where the API was last touched.

configObjects and configOptions elements implemented with the base
ast_config APIs were just not possible to find due to the non-deterministic
way they are accessed.

Also note that if the API call was on modified after it was added, the
version will be the one it was last modified in.

Final note:  The configObject and configOption elements were introduced in
12.0.0 so options created before then may not have any XML documentation.
This commit is contained in:
George Joseph
2025-01-16 14:54:35 -07:00
parent fb533fcc73
commit 772221c82a
31 changed files with 650 additions and 0 deletions

View File

@@ -149,38 +149,50 @@
</description>
<configFile name="motif.conf">
<configObject name="endpoint">
<since><version>12.0.0</version></since>
<synopsis>The configuration for an endpoint.</synopsis>
<configOption name="context">
<since><version>11.0.0</version></since>
<synopsis>Default dialplan context that incoming sessions will be routed to</synopsis>
</configOption>
<configOption name="callgroup">
<since><version>11.0.0</version></since>
<synopsis>A callgroup to assign to this endpoint.</synopsis>
</configOption>
<configOption name="pickupgroup">
<since><version>11.0.0</version></since>
<synopsis>A pickup group to assign to this endpoint.</synopsis>
</configOption>
<configOption name="language">
<since><version>11.0.0</version></since>
<synopsis>The default language for this endpoint.</synopsis>
</configOption>
<configOption name="musicclass">
<since><version>11.0.0</version></since>
<synopsis>Default music on hold class for this endpoint.</synopsis>
</configOption>
<configOption name="parkinglot">
<since><version>11.0.0</version></since>
<synopsis>Default parking lot for this endpoint.</synopsis>
</configOption>
<configOption name="accountcode">
<since><version>11.0.0</version></since>
<synopsis>Accout code for CDR purposes</synopsis>
</configOption>
<configOption name="allow">
<since><version>13.0.0</version></since>
<synopsis>Codecs to allow</synopsis>
</configOption>
<configOption name="disallow">
<since><version>13.0.0</version></since>
<synopsis>Codecs to disallow</synopsis>
</configOption>
<configOption name="connection">
<since><version>11.0.0</version></since>
<synopsis>Connection to accept traffic on and on which to send traffic out</synopsis>
</configOption>
<configOption name="transport">
<since><version>11.0.0</version></since>
<synopsis>The transport to use for the endpoint.</synopsis>
<description>
<para>The default outbound transport for this endpoint. Inbound
@@ -206,9 +218,11 @@
</description>
</configOption>
<configOption name="maxicecandidates">
<since><version>11.0.0</version></since>
<synopsis>Maximum number of ICE candidates to offer</synopsis>
</configOption>
<configOption name="maxpayloads">
<since><version>11.0.0</version></since>
<synopsis>Maximum number of payloads to offer</synopsis>
</configOption>
</configObject>