Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@joniles
joniles committed May 13, 2024
1 parent 32c7290 commit 29405ae
Show file tree
Hide file tree
Showing 2,147 changed files with 6,702 additions and 4,638 deletions.
39 changes: 34 additions & 5 deletions docs/CHANGELOG/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -291,9 +291,18 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

<li class="md-nav__item">
<a href="#1294-unreleased" class="md-nav__link">
<a href="#12101-unreleased" class="md-nav__link">
<span class="md-ellipsis">
12.9.4 (unreleased)
12.10.1 (unreleased)
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#12100-2024-05-13" class="md-nav__link">
<span class="md-ellipsis">
12.10.0 (2024-05-13)
</span>
</a>

Expand Down Expand Up @@ -3781,9 +3790,18 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

<li class="md-nav__item">
<a href="#1294-unreleased" class="md-nav__link">
<a href="#12101-unreleased" class="md-nav__link">
<span class="md-ellipsis">
12.9.4 (unreleased)
12.10.1 (unreleased)
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#12100-2024-05-13" class="md-nav__link">
<span class="md-ellipsis">
12.10.0 (2024-05-13)
</span>
</a>

Expand Down Expand Up @@ -5956,7 +5974,18 @@


<h1 id="changelog">Changelog</h1>
<h2 id="1294-unreleased">12.9.4 (unreleased)</h2>
<h2 id="12101-unreleased">12.10.1 (unreleased)</h2>
<h2 id="12100-2024-05-13">12.10.0 (2024-05-13)</h2>
<ul>
<li>When a baseline is added using one of the <code>ProjectFile.setBaseline</code> methods, ensure that the relevant baseline date is set in <code>ProjectProperties</code>.</li>
<li>Marked the <code>JsonWriter</code> methods <code>setEncoding</code> and <code>getEncoding</code> as deprecated, use <code>setCharset</code> and <code>getCharset</code> instead.</li>
<li>Marked the <code>PlannerWriter</code> methods <code>setEncoding</code> and <code>getEncoding</code> as deprecated, use <code>setCharset</code> and <code>getCharset</code> instead.</li>
<li>Marked the <code>PrimaveraXERFileWriter</code> method <code>setEncoding</code> as deprecated, use <code>setCharset</code> instead.</li>
<li>Marked the <code>ProjectCalendarHelper</code> method <code>getExpandedExceptionsWithWorkWeeks</code> as deprecated, use <code>ProjectCalendar.getExpandedCalendarExceptionsWithWorkWeeks</code> instead.</li>
<li>Marked the <code>ProjectReader</code> method <code>setCharset</code> as deprecated. Readers which support setting the Chraset now implement the <code>HasCharset</code> interface, which includes Charset getter and setter methods.</li>
<li>Implemented the <code>UniversalProjectWriter</code> class. This complements the <code>UniversalProjectReader</code> class by providing a simple way for MPXJ users to write project files without having to be concerned with details of the individual <code>ProjectWriter</code> classes. This is intended to replace the <code>ProjectWriterUtility</code> class. Note that the <code>ProjectWriterUtility</code> has a somewhat brittle mechanism to determine the output file format from the supplied output file name. This is not replicated by <code>UniversalProjectWriter</code>, users are expected to provide their own code to determine the appropriate file format.</li>
<li>Marked the <code>ProjectWriterUtility</code> class as deprecated.</li>
</ul>
<h2 id="1293-2024-04-24">12.9.3 (2024-04-24)</h2>
<ul>
<li>Improve handling of non-standard timestamp formats in XER files.</li>
Expand Down
5 changes: 4 additions & 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 12.9.3 API)</title>
<title>All Classes (MPXJ 12.10.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 @@ -305,6 +305,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="net/sf/mpxj/explorer/FileCleanerController.html" title="class in net.sf.mpxj.explorer" target="classFrame">FileCleanerController</a></li>
<li><a href="net/sf/mpxj/explorer/FileCleanerModel.html" title="class in net.sf.mpxj.explorer" target="classFrame">FileCleanerModel</a></li>
<li><a href="net/sf/mpxj/explorer/FileCleanerView.html" title="class in net.sf.mpxj.explorer" target="classFrame">FileCleanerView</a></li>
<li><a href="net/sf/mpxj/writer/FileFormat.html" title="enum in net.sf.mpxj.writer" target="classFrame">FileFormat</a></li>
<li><a href="net/sf/mpxj/common/FileHelper.html" title="class in net.sf.mpxj.common" target="classFrame">FileHelper</a></li>
<li><a href="net/sf/mpxj/explorer/FileSaverController.html" title="class in net.sf.mpxj.explorer" target="classFrame">FileSaverController</a></li>
<li><a href="net/sf/mpxj/explorer/FileSaverModel.html" title="class in net.sf.mpxj.explorer" target="classFrame">FileSaverModel</a></li>
Expand Down Expand Up @@ -401,6 +402,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="net/sf/mpxj/mpp/GroupReader12.html" title="class in net.sf.mpxj.mpp" target="classFrame">GroupReader12</a></li>
<li><a href="net/sf/mpxj/mpp/GroupReader14.html" title="class in net.sf.mpxj.mpp" target="classFrame">GroupReader14</a></li>
<li><a href="net/sf/mpxj/mpp/GroupReader9.html" title="class in net.sf.mpxj.mpp" target="classFrame">GroupReader9</a></li>
<li><a href="net/sf/mpxj/HasCharset.html" title="interface in net.sf.mpxj" target="classFrame"><span class="interfaceName">HasCharset</span></a></li>
<li><a href="net/sf/mpxj/sample/HexDump.html" title="class in net.sf.mpxj.sample" target="classFrame">HexDump</a></li>
<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>
Expand Down Expand Up @@ -834,6 +836,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="net/sf/mpxj/primavera/schema/UnitOfMeasureType.html" title="class in net.sf.mpxj.primavera.schema" target="classFrame">UnitOfMeasureType</a></li>
<li><a href="net/sf/mpxj/reader/UniversalProjectReader.html" title="class in net.sf.mpxj.reader" target="classFrame">UniversalProjectReader</a></li>
<li><a href="net/sf/mpxj/reader/UniversalProjectReader.ProjectReaderProxy.html" title="interface in net.sf.mpxj.reader" target="classFrame"><span class="interfaceName">UniversalProjectReader.ProjectReaderProxy</span></a></li>
<li><a href="net/sf/mpxj/writer/UniversalProjectWriter.html" title="class in net.sf.mpxj.writer" target="classFrame">UniversalProjectWriter</a></li>
<li><a href="net/sf/mpxj/common/UnmarshalHelper.html" title="class in net.sf.mpxj.common" target="classFrame">UnmarshalHelper</a></li>
<li><a href="net/sf/mpxj/primavera/schema/UpdateBaselineOptionType.html" title="class in net.sf.mpxj.primavera.schema" target="classFrame">UpdateBaselineOptionType</a></li>
<li><a href="net/sf/mpxj/primavera/schema/UserConsentType.html" title="class in net.sf.mpxj.primavera.schema" target="classFrame">UserConsentType</a></li>
Expand Down
5 changes: 4 additions & 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 12.9.3 API)</title>
<title>All Classes (MPXJ 12.10.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 @@ -305,6 +305,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="net/sf/mpxj/explorer/FileCleanerController.html" title="class in net.sf.mpxj.explorer">FileCleanerController</a></li>
<li><a href="net/sf/mpxj/explorer/FileCleanerModel.html" title="class in net.sf.mpxj.explorer">FileCleanerModel</a></li>
<li><a href="net/sf/mpxj/explorer/FileCleanerView.html" title="class in net.sf.mpxj.explorer">FileCleanerView</a></li>
<li><a href="net/sf/mpxj/writer/FileFormat.html" title="enum in net.sf.mpxj.writer">FileFormat</a></li>
<li><a href="net/sf/mpxj/common/FileHelper.html" title="class in net.sf.mpxj.common">FileHelper</a></li>
<li><a href="net/sf/mpxj/explorer/FileSaverController.html" title="class in net.sf.mpxj.explorer">FileSaverController</a></li>
<li><a href="net/sf/mpxj/explorer/FileSaverModel.html" title="class in net.sf.mpxj.explorer">FileSaverModel</a></li>
Expand Down Expand Up @@ -401,6 +402,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="net/sf/mpxj/mpp/GroupReader12.html" title="class in net.sf.mpxj.mpp">GroupReader12</a></li>
<li><a href="net/sf/mpxj/mpp/GroupReader14.html" title="class in net.sf.mpxj.mpp">GroupReader14</a></li>
<li><a href="net/sf/mpxj/mpp/GroupReader9.html" title="class in net.sf.mpxj.mpp">GroupReader9</a></li>
<li><a href="net/sf/mpxj/HasCharset.html" title="interface in net.sf.mpxj"><span class="interfaceName">HasCharset</span></a></li>
<li><a href="net/sf/mpxj/sample/HexDump.html" title="class in net.sf.mpxj.sample">HexDump</a></li>
<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>
Expand Down Expand Up @@ -834,6 +836,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="net/sf/mpxj/primavera/schema/UnitOfMeasureType.html" title="class in net.sf.mpxj.primavera.schema">UnitOfMeasureType</a></li>
<li><a href="net/sf/mpxj/reader/UniversalProjectReader.html" title="class in net.sf.mpxj.reader">UniversalProjectReader</a></li>
<li><a href="net/sf/mpxj/reader/UniversalProjectReader.ProjectReaderProxy.html" title="interface in net.sf.mpxj.reader"><span class="interfaceName">UniversalProjectReader.ProjectReaderProxy</span></a></li>
<li><a href="net/sf/mpxj/writer/UniversalProjectWriter.html" title="class in net.sf.mpxj.writer">UniversalProjectWriter</a></li>
<li><a href="net/sf/mpxj/common/UnmarshalHelper.html" title="class in net.sf.mpxj.common">UnmarshalHelper</a></li>
<li><a href="net/sf/mpxj/primavera/schema/UpdateBaselineOptionType.html" title="class in net.sf.mpxj.primavera.schema">UpdateBaselineOptionType</a></li>
<li><a href="net/sf/mpxj/primavera/schema/UserConsentType.html" title="class in net.sf.mpxj.primavera.schema">UserConsentType</a></li>
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 12.9.3 API)</title>
<title>Constant Field Values (MPXJ 12.10.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.9.3 API)";
parent.document.title="Constant Field Values (MPXJ 12.10.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.9.3"</code></td>
<td class="colLast"><code>"12.10.0"</code></td>
</tr>
</tbody>
</table>
Expand Down

0 comments on commit 29405ae

Please sign in to comment.