Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
joniles committed Nov 23, 2023
1 parent d67e127 commit 8b28398
Show file tree
Hide file tree
Showing 2,123 changed files with 8,562 additions and 4,558 deletions.
40 changes: 35 additions & 5 deletions docs/CHANGELOG/index.html
Expand Up @@ -289,8 +289,15 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

<li class="md-nav__item">
<a href="#1240-unreleased" class="md-nav__link">
12.4.0 (unreleased)
<a href="#1241-unreleased" class="md-nav__link">
12.4.1 (unreleased)
</a>

</li>

<li class="md-nav__item">
<a href="#1240-2023-11-23" class="md-nav__link">
12.4.0 (2023-11-23)
</a>

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

<li class="md-nav__item">
<a href="#1240-unreleased" class="md-nav__link">
12.4.0 (unreleased)
<a href="#1241-unreleased" class="md-nav__link">
12.4.1 (unreleased)
</a>

</li>

<li class="md-nav__item">
<a href="#1240-2023-11-23" class="md-nav__link">
12.4.0 (2023-11-23)
</a>

</li>
Expand Down Expand Up @@ -4747,9 +4761,14 @@


<h1 id="changelog">Changelog</h1>
<h2 id="1240-unreleased">12.4.0 (unreleased)</h2>
<h2 id="1241-unreleased">12.4.1 (unreleased)</h2>
<h2 id="1240-2023-11-23">12.4.0 (2023-11-23)</h2>
<ul>
<li>Added support for the WBS Code Separator attribute to <code>ProjectProperties</code>.</li>
<li>Avoid creating duplicate <code>ActivityCodeValue</code> instances when reading Asta PP files.</li>
<li>Added a new version of the <code>ProjectFile.expandSubprojects</code> method which takes a <code>boolean</code> argument indicating if external tasks should be removed. Passing <code>true</code> to this method will recreate predecessor and successor relationships using the original tasks rather than the placeholder external tasks, and will remove the external tasks.</li>
<li>Marked the <code>ProjectFile.expandSubprojects()</code> method as deprecated, use the new version which takes a <code>boolean</code> argument instead.</li>
<li>Ensure the <code>ProjectProperties</code> name attribute is set correctly when reading XER files and P6 databases.</li>
<li>The <code>ProjectEntityContainer</code> method <code>renumberUniqueIDs</code> has been marked as deprecated.</li>
<li>The <code>ProjectEntityContainer</code> method <code>getNextUniqueID</code> has been marked as deprecated. Use <code>ProjectFile.getUniqueIdObjectSequence(class).getNext()</code> instead.</li>
<li>The <code>ProjectEntityContainer</code> method <code>updateUniqueIdCounter</code> has been marked as deprecated as it is no longer required.</li>
Expand All @@ -4765,6 +4784,17 @@ <h2 id="1240-unreleased">12.4.0 (unreleased)</h2>
<li>Marked the <code>Step(task)</code> constructor as deprecated, use the <code>Step.Builder</code> class instead.</li>
<li>Marked all <code>Step</code> setter methods a deprecated. The <code>Step</code> class will be immutable in the next major release.</li>
<li>Marked the <code>NotesTopic</code> constructor as deprecated, use the <code>NotesTopic.Builder(ProjectFile)</code> constructor instead.</li>
<li>Implemented the <code>ExpenseCategory.Builder</code> class.</li>
<li>Marked the <code>ExpenseCategory</code> constructor as deprecated, use the <code>ExpenseCategory.Builder</code> class instead.</li>
<li>Implemented the <code>CostAccount.Builder</code> class.</li>
<li>Marked the <code>CostAccount</code> constructor as deprecated, use the <code>CostAccount.Builder</code> class instead.</li>
<li>Implemented the <code>ActivityCodeValue.Builder</code> class.</li>
<li>Marked the <code>ActivityCodeValue</code> constructor as deprecated, use the <code>ActivityCodeValue.Builder</code> class instead.</li>
<li>Marked the <code>ActivityCodeValue.setParent</code> method as deprecated, use the <code>ActivityCodeValue.Builder</code> class instead.</li>
<li>Marked the <code>ActivityCode.addValue</code> method as deprecated, use the <code>ActivityCodeValue.Builder</code> class instead to create an <code>ActivityCodeValue</code> instance and add it directly to the list held by the parent <code>ActivityCode</code>.</li>
<li>Implemented the <code>ActivityCode.Builder</code> class.</li>
<li>Marked the <code>ActivityCode</code> constructor as deprecated, use the <code>ActivityCode.Builder</code> class instead.</li>
<li>Only predecessor <code>Relation</code> instances are now stored in <code>RelationContainer</code>, successors are generated dynamically. You will only notice a difference if you are iterating over the <code>RelationContainer</code> collection directly, in which case you will only see predecessors.</li>
</ul>
<h2 id="1230-2023-11-07">12.3.0 (2023-11-07)</h2>
<ul>
Expand Down
7 changes: 6 additions & 1 deletion docs/apidocs/allclasses-frame.html
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 12.3.0 API)</title>
<title>All Classes (MPXJ 12.4.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 Expand Up @@ -34,13 +34,15 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="net/sf/mpxj/AccrueType.html" title="enum in net.sf.mpxj" target="classFrame">AccrueType</a></li>
<li><a href="net/sf/mpxj/conceptdraw/schema/ActiveFilter.html" title="class in net.sf.mpxj.conceptdraw.schema" target="classFrame">ActiveFilter</a></li>
<li><a href="net/sf/mpxj/ActivityCode.html" title="class in net.sf.mpxj" target="classFrame">ActivityCode</a></li>
<li><a href="net/sf/mpxj/ActivityCode.Builder.html" title="class in net.sf.mpxj" target="classFrame">ActivityCode.Builder</a></li>
<li><a href="net/sf/mpxj/primavera/schema/ActivityCodeAssignmentType.html" title="class in net.sf.mpxj.primavera.schema" target="classFrame">ActivityCodeAssignmentType</a></li>
<li><a href="net/sf/mpxj/ActivityCodeContainer.html" title="class in net.sf.mpxj" target="classFrame">ActivityCodeContainer</a></li>
<li><a href="net/sf/mpxj/ActivityCodeScope.html" title="enum in net.sf.mpxj" target="classFrame">ActivityCodeScope</a></li>
<li><a href="net/sf/mpxj/primavera/schema/ActivityCodeType.html" title="class in net.sf.mpxj.primavera.schema" target="classFrame">ActivityCodeType</a></li>
<li><a href="net/sf/mpxj/primavera/schema/ActivityCodeTypeType.html" title="class in net.sf.mpxj.primavera.schema" target="classFrame">ActivityCodeTypeType</a></li>
<li><a href="net/sf/mpxj/primavera/schema/ActivityCodeUpdateType.html" title="class in net.sf.mpxj.primavera.schema" target="classFrame">ActivityCodeUpdateType</a></li>
<li><a href="net/sf/mpxj/ActivityCodeValue.html" title="class in net.sf.mpxj" target="classFrame">ActivityCodeValue</a></li>
<li><a href="net/sf/mpxj/ActivityCodeValue.Builder.html" title="class in net.sf.mpxj" target="classFrame">ActivityCodeValue.Builder</a></li>
<li><a href="net/sf/mpxj/primavera/schema/ActivityCommentType.html" title="class in net.sf.mpxj.primavera.schema" target="classFrame">ActivityCommentType</a></li>
<li><a href="net/sf/mpxj/primavera/schema/ActivityExpenseType.html" title="class in net.sf.mpxj.primavera.schema" target="classFrame">ActivityExpenseType</a></li>
<li><a href="net/sf/mpxj/primavera/schema/ActivityFilterType.html" title="class in net.sf.mpxj.primavera.schema" target="classFrame">ActivityFilterType</a></li>
Expand Down Expand Up @@ -187,6 +189,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="net/sf/mpxj/ConstraintField.html" title="enum in net.sf.mpxj" target="classFrame">ConstraintField</a></li>
<li><a href="net/sf/mpxj/ConstraintType.html" title="enum in net.sf.mpxj" target="classFrame">ConstraintType</a></li>
<li><a href="net/sf/mpxj/CostAccount.html" title="class in net.sf.mpxj" target="classFrame">CostAccount</a></li>
<li><a href="net/sf/mpxj/CostAccount.Builder.html" title="class in net.sf.mpxj" target="classFrame">CostAccount.Builder</a></li>
<li><a href="net/sf/mpxj/CostAccountContainer.html" title="class in net.sf.mpxj" target="classFrame">CostAccountContainer</a></li>
<li><a href="net/sf/mpxj/primavera/schema/CostAccountType.html" title="class in net.sf.mpxj.primavera.schema" target="classFrame">CostAccountType</a></li>
<li><a href="net/sf/mpxj/CostRateTable.html" title="class in net.sf.mpxj" target="classFrame">CostRateTable</a></li>
Expand Down Expand Up @@ -282,6 +285,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="net/sf/mpxj/primavera/schema/EPSType.html" title="class in net.sf.mpxj.primavera.schema" target="classFrame">EPSType</a></li>
<li><a href="net/sf/mpxj/EventManager.html" title="class in net.sf.mpxj" target="classFrame">EventManager</a></li>
<li><a href="net/sf/mpxj/ExpenseCategory.html" title="class in net.sf.mpxj" target="classFrame">ExpenseCategory</a></li>
<li><a href="net/sf/mpxj/ExpenseCategory.Builder.html" title="class in net.sf.mpxj" target="classFrame">ExpenseCategory.Builder</a></li>
<li><a href="net/sf/mpxj/ExpenseCategoryContainer.html" title="class in net.sf.mpxj" target="classFrame">ExpenseCategoryContainer</a></li>
<li><a href="net/sf/mpxj/primavera/schema/ExpenseCategoryType.html" title="class in net.sf.mpxj.primavera.schema" target="classFrame">ExpenseCategoryType</a></li>
<li><a href="net/sf/mpxj/ExpenseItem.html" title="class in net.sf.mpxj" target="classFrame">ExpenseItem</a></li>
Expand Down Expand Up @@ -401,6 +405,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="net/sf/mpxj/explorer/HexDumpController.html" title="class in net.sf.mpxj.explorer" target="classFrame">HexDumpController</a></li>
<li><a href="net/sf/mpxj/explorer/HexDumpModel.html" title="class in net.sf.mpxj.explorer" target="classFrame">HexDumpModel</a></li>
<li><a href="net/sf/mpxj/explorer/HexDumpView.html" title="class in net.sf.mpxj.explorer" target="classFrame">HexDumpView</a></li>
<li><a href="net/sf/mpxj/common/HierarchyHelper.html" title="class in net.sf.mpxj.common" target="classFrame">HierarchyHelper</a></li>
<li><a href="net/sf/mpxj/common/HtmlHelper.html" title="class in net.sf.mpxj.common" target="classFrame">HtmlHelper</a></li>
<li><a href="net/sf/mpxj/HtmlNotes.html" title="class in net.sf.mpxj" target="classFrame">HtmlNotes</a></li>
<li><a href="net/sf/mpxj/conceptdraw/schema/Hyperlinks.html" title="class in net.sf.mpxj.conceptdraw.schema" target="classFrame">Hyperlinks</a></li>
Expand Down
7 changes: 6 additions & 1 deletion docs/apidocs/allclasses-noframe.html
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 12.3.0 API)</title>
<title>All Classes (MPXJ 12.4.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 Expand Up @@ -34,13 +34,15 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="net/sf/mpxj/AccrueType.html" title="enum in net.sf.mpxj">AccrueType</a></li>
<li><a href="net/sf/mpxj/conceptdraw/schema/ActiveFilter.html" title="class in net.sf.mpxj.conceptdraw.schema">ActiveFilter</a></li>
<li><a href="net/sf/mpxj/ActivityCode.html" title="class in net.sf.mpxj">ActivityCode</a></li>
<li><a href="net/sf/mpxj/ActivityCode.Builder.html" title="class in net.sf.mpxj">ActivityCode.Builder</a></li>
<li><a href="net/sf/mpxj/primavera/schema/ActivityCodeAssignmentType.html" title="class in net.sf.mpxj.primavera.schema">ActivityCodeAssignmentType</a></li>
<li><a href="net/sf/mpxj/ActivityCodeContainer.html" title="class in net.sf.mpxj">ActivityCodeContainer</a></li>
<li><a href="net/sf/mpxj/ActivityCodeScope.html" title="enum in net.sf.mpxj">ActivityCodeScope</a></li>
<li><a href="net/sf/mpxj/primavera/schema/ActivityCodeType.html" title="class in net.sf.mpxj.primavera.schema">ActivityCodeType</a></li>
<li><a href="net/sf/mpxj/primavera/schema/ActivityCodeTypeType.html" title="class in net.sf.mpxj.primavera.schema">ActivityCodeTypeType</a></li>
<li><a href="net/sf/mpxj/primavera/schema/ActivityCodeUpdateType.html" title="class in net.sf.mpxj.primavera.schema">ActivityCodeUpdateType</a></li>
<li><a href="net/sf/mpxj/ActivityCodeValue.html" title="class in net.sf.mpxj">ActivityCodeValue</a></li>
<li><a href="net/sf/mpxj/ActivityCodeValue.Builder.html" title="class in net.sf.mpxj">ActivityCodeValue.Builder</a></li>
<li><a href="net/sf/mpxj/primavera/schema/ActivityCommentType.html" title="class in net.sf.mpxj.primavera.schema">ActivityCommentType</a></li>
<li><a href="net/sf/mpxj/primavera/schema/ActivityExpenseType.html" title="class in net.sf.mpxj.primavera.schema">ActivityExpenseType</a></li>
<li><a href="net/sf/mpxj/primavera/schema/ActivityFilterType.html" title="class in net.sf.mpxj.primavera.schema">ActivityFilterType</a></li>
Expand Down Expand Up @@ -187,6 +189,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="net/sf/mpxj/ConstraintField.html" title="enum in net.sf.mpxj">ConstraintField</a></li>
<li><a href="net/sf/mpxj/ConstraintType.html" title="enum in net.sf.mpxj">ConstraintType</a></li>
<li><a href="net/sf/mpxj/CostAccount.html" title="class in net.sf.mpxj">CostAccount</a></li>
<li><a href="net/sf/mpxj/CostAccount.Builder.html" title="class in net.sf.mpxj">CostAccount.Builder</a></li>
<li><a href="net/sf/mpxj/CostAccountContainer.html" title="class in net.sf.mpxj">CostAccountContainer</a></li>
<li><a href="net/sf/mpxj/primavera/schema/CostAccountType.html" title="class in net.sf.mpxj.primavera.schema">CostAccountType</a></li>
<li><a href="net/sf/mpxj/CostRateTable.html" title="class in net.sf.mpxj">CostRateTable</a></li>
Expand Down Expand Up @@ -282,6 +285,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="net/sf/mpxj/primavera/schema/EPSType.html" title="class in net.sf.mpxj.primavera.schema">EPSType</a></li>
<li><a href="net/sf/mpxj/EventManager.html" title="class in net.sf.mpxj">EventManager</a></li>
<li><a href="net/sf/mpxj/ExpenseCategory.html" title="class in net.sf.mpxj">ExpenseCategory</a></li>
<li><a href="net/sf/mpxj/ExpenseCategory.Builder.html" title="class in net.sf.mpxj">ExpenseCategory.Builder</a></li>
<li><a href="net/sf/mpxj/ExpenseCategoryContainer.html" title="class in net.sf.mpxj">ExpenseCategoryContainer</a></li>
<li><a href="net/sf/mpxj/primavera/schema/ExpenseCategoryType.html" title="class in net.sf.mpxj.primavera.schema">ExpenseCategoryType</a></li>
<li><a href="net/sf/mpxj/ExpenseItem.html" title="class in net.sf.mpxj">ExpenseItem</a></li>
Expand Down Expand Up @@ -401,6 +405,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="net/sf/mpxj/explorer/HexDumpController.html" title="class in net.sf.mpxj.explorer">HexDumpController</a></li>
<li><a href="net/sf/mpxj/explorer/HexDumpModel.html" title="class in net.sf.mpxj.explorer">HexDumpModel</a></li>
<li><a href="net/sf/mpxj/explorer/HexDumpView.html" title="class in net.sf.mpxj.explorer">HexDumpView</a></li>
<li><a href="net/sf/mpxj/common/HierarchyHelper.html" title="class in net.sf.mpxj.common">HierarchyHelper</a></li>
<li><a href="net/sf/mpxj/common/HtmlHelper.html" title="class in net.sf.mpxj.common">HtmlHelper</a></li>
<li><a href="net/sf/mpxj/HtmlNotes.html" title="class in net.sf.mpxj">HtmlNotes</a></li>
<li><a href="net/sf/mpxj/conceptdraw/schema/Hyperlinks.html" title="class in net.sf.mpxj.conceptdraw.schema">Hyperlinks</a></li>
Expand Down
6 changes: 3 additions & 3 deletions docs/apidocs/constant-values.html
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 12.3.0 API)</title>
<title>Constant Field Values (MPXJ 12.4.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 12.3.0 API)";
parent.document.title="Constant Field Values (MPXJ 12.4.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>"12.3.0"</code></td>
<td class="colLast"><code>"12.4.0"</code></td>
</tr>
</tbody>
</table>
Expand Down

0 comments on commit 8b28398

Please sign in to comment.