Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@joniles
joniles committed Feb 15, 2023
1 parent f63738b commit ff6176a
Show file tree
Hide file tree
Showing 2,048 changed files with 4,304 additions and 4,115 deletions.
31 changes: 26 additions & 5 deletions docs/CHANGELOG/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -271,8 +271,15 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

<li class="md-nav__item">
<a href="#1101-unreleased" class="md-nav__link">
11.0.1 (unreleased)
<a href="#1111-unreleased" class="md-nav__link">
11.1.1 (unreleased)
</a>

</li>

<li class="md-nav__item">
<a href="#1110-2023-02-15" class="md-nav__link">
11.1.0 (2023-02-15)
</a>

</li>
Expand Down Expand Up @@ -2552,8 +2559,15 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

<li class="md-nav__item">
<a href="#1101-unreleased" class="md-nav__link">
11.0.1 (unreleased)
<a href="#1111-unreleased" class="md-nav__link">
11.1.1 (unreleased)
</a>

</li>

<li class="md-nav__item">
<a href="#1110-2023-02-15" class="md-nav__link">
11.1.0 (2023-02-15)
</a>

</li>
Expand Down Expand Up @@ -4038,7 +4052,14 @@


<h1 id="changelog">Changelog</h1>
<h2 id="1101-unreleased">11.0.1 (unreleased)</h2>
<h2 id="1111-unreleased">11.1.1 (unreleased)</h2>
<h2 id="1110-2023-02-15">11.1.0 (2023-02-15)</h2>
<ul>
<li>Write activity code definitions and activity code assignments to PMXML files.</li>
<li>Added support for "secure" and "max length" attributes to the <code>ActivityCode</code> class.</li>
<li>Added <code>getChildCodes</code> method to <code>ActivityCode</code> and <code>ActivityCodeValue</code> to make it easier to traverse activity code values hierarchically.</li>
<li>Added <code>setDescription</code> method to <code>Step</code> class to make it simpler to add a plan text description.</li>
</ul>
<h2 id="1100-2023-02-08">11.0.0 (2023-02-08)</h2>
<ul>
<li>User defined fields read from P6, Asta and GanttProject schedules are now represented by instances of <code>UserDefinedField</code>. They will no longer be mapped to custom field instances.</li>
Expand Down
2 changes: 1 addition & 1 deletion docs/apidocs/allclasses-frame.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>All Classes (MPXJ 11.0.0 API)</title>
<title>All Classes (MPXJ 11.1.0 API)</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
Expand Down
2 changes: 1 addition & 1 deletion docs/apidocs/allclasses-noframe.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>All Classes (MPXJ 11.0.0 API)</title>
<title>All Classes (MPXJ 11.1.0 API)</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
Expand Down
6 changes: 3 additions & 3 deletions docs/apidocs/constant-values.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Constant Field Values (MPXJ 11.0.0 API)</title>
<title>Constant Field Values (MPXJ 11.1.0 API)</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
Expand All @@ -19,7 +19,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Constant Field Values (MPXJ 11.0.0 API)";
parent.document.title="Constant Field Values (MPXJ 11.1.0 API)";
}
}
catch(err) {
Expand Down Expand Up @@ -220,7 +220,7 @@ <h2 title="net.sf">net.sf.*</h2>
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td><code><a href="net/sf/mpxj/MPXJ.html#VERSION">VERSION</a></code></td>
<td class="colLast"><code>"11.0.0"</code></td>
<td class="colLast"><code>"11.1.0"</code></td>
</tr>
</tbody>
</table>
Expand Down
4 changes: 2 additions & 2 deletions docs/apidocs/deprecated-list.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Deprecated List (MPXJ 11.0.0 API)</title>
<title>Deprecated List (MPXJ 11.1.0 API)</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
Expand All @@ -19,7 +19,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Deprecated List (MPXJ 11.0.0 API)";
parent.document.title="Deprecated List (MPXJ 11.1.0 API)";
}
}
catch(err) {
Expand Down
4 changes: 2 additions & 2 deletions docs/apidocs/help-doc.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>API Help (MPXJ 11.0.0 API)</title>
<title>API Help (MPXJ 11.1.0 API)</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
Expand All @@ -19,7 +19,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="API Help (MPXJ 11.0.0 API)";
parent.document.title="API Help (MPXJ 11.1.0 API)";
}
}
catch(err) {
Expand Down
29 changes: 25 additions & 4 deletions docs/apidocs/index-all.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Index (MPXJ 11.0.0 API)</title>
<title>Index (MPXJ 11.1.0 API)</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
Expand All @@ -19,7 +19,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Index (MPXJ 11.0.0 API)";
parent.document.title="Index (MPXJ 11.1.0 API)";
}
}
catch(err) {
Expand Down Expand Up @@ -228,7 +228,7 @@ <h2 class="title">A</h2>
<div class="block">Activity code type definition, contains a list of the valid
values for this activity code.</div>
</dd>
<dt><span class="memberNameLink"><a href="net/sf/mpxj/ActivityCode.html#ActivityCode-java.lang.Integer-net.sf.mpxj.ActivityCodeScope-java.lang.Integer-java.lang.Integer-java.lang.String-">ActivityCode(Integer, ActivityCodeScope, Integer, Integer, String)</a></span> - Constructor for class net.sf.mpxj.<a href="net/sf/mpxj/ActivityCode.html" title="class in net.sf.mpxj">ActivityCode</a></dt>
<dt><span class="memberNameLink"><a href="net/sf/mpxj/ActivityCode.html#ActivityCode-java.lang.Integer-net.sf.mpxj.ActivityCodeScope-java.lang.Integer-java.lang.Integer-java.lang.String-boolean-java.lang.Integer-">ActivityCode(Integer, ActivityCodeScope, Integer, Integer, String, boolean, Integer)</a></span> - Constructor for class net.sf.mpxj.<a href="net/sf/mpxj/ActivityCode.html" title="class in net.sf.mpxj">ActivityCode</a></dt>
<dd>
<div class="block">Constructor.</div>
</dd>
Expand Down Expand Up @@ -12362,6 +12362,14 @@ <h2 class="title">G</h2>
<div class="block">This method retrieves a list of child tasks relative to the
current task, as defined by the outline level.</div>
</dd>
<dt><span class="memberNameLink"><a href="net/sf/mpxj/ActivityCode.html#getChildValues--">getChildValues()</a></span> - Method in class net.sf.mpxj.<a href="net/sf/mpxj/ActivityCode.html" title="class in net.sf.mpxj">ActivityCode</a></dt>
<dd>
<div class="block">Retrieve a list of top level values for his activity code.</div>
</dd>
<dt><span class="memberNameLink"><a href="net/sf/mpxj/ActivityCodeValue.html#getChildValues--">getChildValues()</a></span> - Method in class net.sf.mpxj.<a href="net/sf/mpxj/ActivityCodeValue.html" title="class in net.sf.mpxj">ActivityCodeValue</a></dt>
<dd>
<div class="block">Retrieve any children of this value.</div>
</dd>
<dt><span class="memberNameLink"><a href="net/sf/mpxj/primavera/schema/LocationType.html#getCity--">getCity()</a></span> - Method in class net.sf.mpxj.primavera.schema.<a href="net/sf/mpxj/primavera/schema/LocationType.html" title="class in net.sf.mpxj.primavera.schema">LocationType</a></dt>
<dd>
<div class="block">Gets the value of the city property.</div>
Expand Down Expand Up @@ -22176,6 +22184,10 @@ <h2 class="title">G</h2>
<dd>
<div class="block">Gets the value of the maximumSlack property.</div>
</dd>
<dt><span class="memberNameLink"><a href="net/sf/mpxj/ActivityCode.html#getMaxLength--">getMaxLength()</a></span> - Method in class net.sf.mpxj.<a href="net/sf/mpxj/ActivityCode.html" title="class in net.sf.mpxj">ActivityCode</a></dt>
<dd>
<div class="block">Retrieve the max length.</div>
</dd>
<dt><span class="memberNameLink"><a href="net/sf/mpxj/mspdi/schema/Project.ExtendedAttributes.ExtendedAttribute.html#getMaxMultiValues--">getMaxMultiValues()</a></span> - Method in class net.sf.mpxj.mspdi.schema.<a href="net/sf/mpxj/mspdi/schema/Project.ExtendedAttributes.ExtendedAttribute.html" title="class in net.sf.mpxj.mspdi.schema">Project.ExtendedAttributes.ExtendedAttribute</a></dt>
<dd>
<div class="block">Gets the value of the maxMultiValues property.</div>
Expand Down Expand Up @@ -29134,6 +29146,10 @@ <h2 class="title">G</h2>
<dd>
<div class="block">Retrieve the section field.</div>
</dd>
<dt><span class="memberNameLink"><a href="net/sf/mpxj/ActivityCode.html#getSecure--">getSecure()</a></span> - Method in class net.sf.mpxj.<a href="net/sf/mpxj/ActivityCode.html" title="class in net.sf.mpxj">ActivityCode</a></dt>
<dd>
<div class="block">Retrieve the secure flag.</div>
</dd>
<dt><span class="memberNameLink"><a href="net/sf/mpxj/explorer/HexDumpModel.html#getSelectedCell--">getSelectedCell()</a></span> - Method in class net.sf.mpxj.explorer.<a href="net/sf/mpxj/explorer/HexDumpModel.html" title="class in net.sf.mpxj.explorer">HexDumpModel</a></dt>
<dd>
<div class="block">Retrieve the current table selection as a row and column point.</div>
Expand Down Expand Up @@ -35110,7 +35126,8 @@ <h2 class="title">G</h2>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="net/sf/mpxj/ActivityCode.html#getValues--">getValues()</a></span> - Method in class net.sf.mpxj.<a href="net/sf/mpxj/ActivityCode.html" title="class in net.sf.mpxj">ActivityCode</a></dt>
<dd>
<div class="block">Retrieve a list of values for this activity code.</div>
<div class="block">Retrieve a list of all values for this activity code,
including child values from the hierarchy.</div>
</dd>
<dt><span class="memberNameLink"><a href="net/sf/mpxj/mspdi/schema/Project.OutlineCodes.OutlineCode.html#getValues--">getValues()</a></span> - Method in class net.sf.mpxj.mspdi.schema.<a href="net/sf/mpxj/mspdi/schema/Project.OutlineCodes.OutlineCode.html" title="class in net.sf.mpxj.mspdi.schema">Project.OutlineCodes.OutlineCode</a></dt>
<dd>
Expand Down Expand Up @@ -54278,6 +54295,10 @@ <h2 class="title">S</h2>
<dd>
<div class="block">Set the description field.</div>
</dd>
<dt><span class="memberNameLink"><a href="net/sf/mpxj/Step.html#setDescription-java.lang.String-">setDescription(String)</a></span> - Method in class net.sf.mpxj.<a href="net/sf/mpxj/Step.html" title="class in net.sf.mpxj">Step</a></dt>
<dd>
<div class="block">Set the step description.</div>
</dd>
<dt><span class="memberNameLink"><a href="net/sf/mpxj/Step.html#setDescriptionObject-net.sf.mpxj.Notes-">setDescriptionObject(Notes)</a></span> - Method in class net.sf.mpxj.<a href="net/sf/mpxj/Step.html" title="class in net.sf.mpxj">Step</a></dt>
<dd>
<div class="block">Set the step description.</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/apidocs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>MPXJ 11.0.0 API</title>
<title>MPXJ 11.1.0 API</title>
<script type="text/javascript">
tmpTargetPage = "" + window.location.search;
if (tmpTargetPage != "" && tmpTargetPage != "undefined")
Expand Down
4 changes: 2 additions & 2 deletions docs/apidocs/net/sf/mpxj/AbstractFieldContainer.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>AbstractFieldContainer (MPXJ 11.0.0 API)</title>
<title>AbstractFieldContainer (MPXJ 11.1.0 API)</title>
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
Expand All @@ -19,7 +19,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="AbstractFieldContainer (MPXJ 11.0.0 API)";
parent.document.title="AbstractFieldContainer (MPXJ 11.1.0 API)";
}
}
catch(err) {
Expand Down
4 changes: 2 additions & 2 deletions docs/apidocs/net/sf/mpxj/AccrueType.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>AccrueType (MPXJ 11.0.0 API)</title>
<title>AccrueType (MPXJ 11.1.0 API)</title>
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
Expand All @@ -19,7 +19,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="AccrueType (MPXJ 11.0.0 API)";
parent.document.title="AccrueType (MPXJ 11.1.0 API)";
}
}
catch(err) {
Expand Down
Loading

0 comments on commit ff6176a

Please sign in to comment.