Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@joniles
joniles committed May 5, 2022
1 parent fc28dc4 commit 1d1c00e
Show file tree
Hide file tree
Showing 2,004 changed files with 7,672 additions and 4,689 deletions.
35 changes: 30 additions & 5 deletions docs/CHANGELOG/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -260,8 +260,15 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

<li class="md-nav__item">
<a href="#1031-unreleased" class="md-nav__link">
10.3.1 (unreleased)
<a href="#1050-unreleased" class="md-nav__link">
10.5.0 (unreleased)
</a>

</li>

<li class="md-nav__item">
<a href="#1040-2022-05-05" class="md-nav__link">
10.4.0 (2022-05-05)
</a>

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

<li class="md-nav__item">
<a href="#1031-unreleased" class="md-nav__link">
10.3.1 (unreleased)
<a href="#1050-unreleased" class="md-nav__link">
10.5.0 (unreleased)
</a>

</li>

<li class="md-nav__item">
<a href="#1040-2022-05-05" class="md-nav__link">
10.4.0 (2022-05-05)
</a>

</li>
Expand Down Expand Up @@ -3614,7 +3628,18 @@


<h1 id="changelog">Changelog</h1>
<h2 id="1031-unreleased">10.3.1 (unreleased)</h2>
<h2 id="1050-unreleased">10.5.0 (unreleased)</h2>
<h2 id="1040-2022-05-05">10.4.0 (2022-05-05)</h2>
<ul>
<li>Remove <code>getParent</code>, <code>setParent</code>, and <code>isDerived</code> from <code>ProjectCalendarWeek</code>. (Note: this will be a breaking change if you were working with <code>ProjectCalendarWeek</code> directly).</li>
<li>The <code>ProjectProperties</code> methds <code>getDefaultCalendarName()</code> and <code>setDefaultCalendarName()</code> have been deprecated. Use <code>getDefaultCalendar()</code> and <code>setDefaultCalendar()</code> instead.</li>
<li>Ensure that percent complete values can be read from MSPDI files even if the values are decimals.</li>
<li>Improve handling of the default calendar when reading certain MSPDI files.</li>
<li>Improve reading certain Phoenix PPX files.</li>
<li>Improve reading certain FastTrack FTS files.</li>
<li>Improve formatting of time project properties when written to JSON.</li>
<li>Improve reading MPP files generated by Microsoft Project 16.0.15128.20158 and later versions.</li>
</ul>
<h2 id="1030-2022-04-29">10.3.0 (2022-04-29)</h2>
<ul>
<li>General improvements to make calendar data read from different file formats more consistent.</li>
Expand Down
8 changes: 7 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 10.3.0 API)</title>
<title>All Classes (MPXJ 10.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 @@ -92,10 +92,16 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="net/sf/mpxj/mspdi/schema/Adapter24.html" title="class in net.sf.mpxj.mspdi.schema" target="classFrame">Adapter24</a></li>
<li><a href="net/sf/mpxj/mspdi/schema/Adapter25.html" title="class in net.sf.mpxj.mspdi.schema" target="classFrame">Adapter25</a></li>
<li><a href="net/sf/mpxj/mspdi/schema/Adapter26.html" title="class in net.sf.mpxj.mspdi.schema" target="classFrame">Adapter26</a></li>
<li><a href="net/sf/mpxj/mspdi/schema/Adapter27.html" title="class in net.sf.mpxj.mspdi.schema" target="classFrame">Adapter27</a></li>
<li><a href="net/sf/mpxj/mspdi/schema/Adapter28.html" title="class in net.sf.mpxj.mspdi.schema" target="classFrame">Adapter28</a></li>
<li><a href="net/sf/mpxj/mspdi/schema/Adapter29.html" title="class in net.sf.mpxj.mspdi.schema" target="classFrame">Adapter29</a></li>
<li><a href="net/sf/mpxj/conceptdraw/schema/Adapter3.html" title="class in net.sf.mpxj.conceptdraw.schema" target="classFrame">Adapter3</a></li>
<li><a href="net/sf/mpxj/ganttdesigner/schema/Adapter3.html" title="class in net.sf.mpxj.ganttdesigner.schema" target="classFrame">Adapter3</a></li>
<li><a href="net/sf/mpxj/mspdi/schema/Adapter3.html" title="class in net.sf.mpxj.mspdi.schema" target="classFrame">Adapter3</a></li>
<li><a href="net/sf/mpxj/primavera/schema/Adapter3.html" title="class in net.sf.mpxj.primavera.schema" target="classFrame">Adapter3</a></li>
<li><a href="net/sf/mpxj/mspdi/schema/Adapter30.html" title="class in net.sf.mpxj.mspdi.schema" target="classFrame">Adapter30</a></li>
<li><a href="net/sf/mpxj/mspdi/schema/Adapter31.html" title="class in net.sf.mpxj.mspdi.schema" target="classFrame">Adapter31</a></li>
<li><a href="net/sf/mpxj/mspdi/schema/Adapter32.html" title="class in net.sf.mpxj.mspdi.schema" target="classFrame">Adapter32</a></li>
<li><a href="net/sf/mpxj/conceptdraw/schema/Adapter4.html" title="class in net.sf.mpxj.conceptdraw.schema" target="classFrame">Adapter4</a></li>
<li><a href="net/sf/mpxj/ganttdesigner/schema/Adapter4.html" title="class in net.sf.mpxj.ganttdesigner.schema" target="classFrame">Adapter4</a></li>
<li><a href="net/sf/mpxj/mspdi/schema/Adapter4.html" title="class in net.sf.mpxj.mspdi.schema" target="classFrame">Adapter4</a></li>
Expand Down
8 changes: 7 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 10.3.0 API)</title>
<title>All Classes (MPXJ 10.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 @@ -92,10 +92,16 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="net/sf/mpxj/mspdi/schema/Adapter24.html" title="class in net.sf.mpxj.mspdi.schema">Adapter24</a></li>
<li><a href="net/sf/mpxj/mspdi/schema/Adapter25.html" title="class in net.sf.mpxj.mspdi.schema">Adapter25</a></li>
<li><a href="net/sf/mpxj/mspdi/schema/Adapter26.html" title="class in net.sf.mpxj.mspdi.schema">Adapter26</a></li>
<li><a href="net/sf/mpxj/mspdi/schema/Adapter27.html" title="class in net.sf.mpxj.mspdi.schema">Adapter27</a></li>
<li><a href="net/sf/mpxj/mspdi/schema/Adapter28.html" title="class in net.sf.mpxj.mspdi.schema">Adapter28</a></li>
<li><a href="net/sf/mpxj/mspdi/schema/Adapter29.html" title="class in net.sf.mpxj.mspdi.schema">Adapter29</a></li>
<li><a href="net/sf/mpxj/conceptdraw/schema/Adapter3.html" title="class in net.sf.mpxj.conceptdraw.schema">Adapter3</a></li>
<li><a href="net/sf/mpxj/ganttdesigner/schema/Adapter3.html" title="class in net.sf.mpxj.ganttdesigner.schema">Adapter3</a></li>
<li><a href="net/sf/mpxj/mspdi/schema/Adapter3.html" title="class in net.sf.mpxj.mspdi.schema">Adapter3</a></li>
<li><a href="net/sf/mpxj/primavera/schema/Adapter3.html" title="class in net.sf.mpxj.primavera.schema">Adapter3</a></li>
<li><a href="net/sf/mpxj/mspdi/schema/Adapter30.html" title="class in net.sf.mpxj.mspdi.schema">Adapter30</a></li>
<li><a href="net/sf/mpxj/mspdi/schema/Adapter31.html" title="class in net.sf.mpxj.mspdi.schema">Adapter31</a></li>
<li><a href="net/sf/mpxj/mspdi/schema/Adapter32.html" title="class in net.sf.mpxj.mspdi.schema">Adapter32</a></li>
<li><a href="net/sf/mpxj/conceptdraw/schema/Adapter4.html" title="class in net.sf.mpxj.conceptdraw.schema">Adapter4</a></li>
<li><a href="net/sf/mpxj/ganttdesigner/schema/Adapter4.html" title="class in net.sf.mpxj.ganttdesigner.schema">Adapter4</a></li>
<li><a href="net/sf/mpxj/mspdi/schema/Adapter4.html" title="class in net.sf.mpxj.mspdi.schema">Adapter4</a></li>
Expand Down
4 changes: 2 additions & 2 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 10.3.0 API)</title>
<title>Constant Field Values (MPXJ 10.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 10.3.0 API)";
parent.document.title="Constant Field Values (MPXJ 10.4.0 API)";
}
}
catch(err) {
Expand Down
46 changes: 28 additions & 18 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 10.3.0 API)</title>
<title>Deprecated List (MPXJ 10.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="Deprecated List (MPXJ 10.3.0 API)";
parent.document.title="Deprecated List (MPXJ 10.4.0 API)";
}
}
catch(err) {
Expand Down Expand Up @@ -101,88 +101,98 @@ <h2 title="Contents">Contents</h2>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="net/sf/mpxj/ProjectProperties.html#getDefaultCalendarName--">net.sf.mpxj.ProjectProperties.getDefaultCalendarName()</a>
<div class="block"><span class="deprecationComment">use `getDefaultCalendar().getName()`</span></div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="net/sf/mpxj/ProjectFile.html#getFinishDate--">net.sf.mpxj.ProjectFile.getFinishDate()</a>
<div class="block"><span class="deprecationComment">use ProjectFile.getLatestFinishDate() or ProjectProperties.getFinishDate()</span></div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colOne"><a href="net/sf/mpxj/Resource.html#getOutlineCode1--">net.sf.mpxj.Resource.getOutlineCode1()</a>
<div class="block"><span class="deprecationComment">use getOutlineCode(1)</span></div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colOne"><a href="net/sf/mpxj/Resource.html#getOutlineCode10--">net.sf.mpxj.Resource.getOutlineCode10()</a>
<div class="block"><span class="deprecationComment">use getOutlineCode(10)</span></div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colOne"><a href="net/sf/mpxj/Resource.html#getOutlineCode2--">net.sf.mpxj.Resource.getOutlineCode2()</a>
<div class="block"><span class="deprecationComment">use getOutlineCode(2)</span></div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colOne"><a href="net/sf/mpxj/Resource.html#getOutlineCode3--">net.sf.mpxj.Resource.getOutlineCode3()</a>
<div class="block"><span class="deprecationComment">use getOutlineCode(3)</span></div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colOne"><a href="net/sf/mpxj/Resource.html#getOutlineCode4--">net.sf.mpxj.Resource.getOutlineCode4()</a>
<div class="block"><span class="deprecationComment">use getOutlineCode(4)</span></div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colOne"><a href="net/sf/mpxj/Resource.html#getOutlineCode5--">net.sf.mpxj.Resource.getOutlineCode5()</a>
<div class="block"><span class="deprecationComment">use getOutlineCode(5)</span></div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colOne"><a href="net/sf/mpxj/Resource.html#getOutlineCode6--">net.sf.mpxj.Resource.getOutlineCode6()</a>
<div class="block"><span class="deprecationComment">use getOutlineCode(6)</span></div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colOne"><a href="net/sf/mpxj/Resource.html#getOutlineCode7--">net.sf.mpxj.Resource.getOutlineCode7()</a>
<div class="block"><span class="deprecationComment">use getOutlineCode(7)</span></div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colOne"><a href="net/sf/mpxj/Resource.html#getOutlineCode8--">net.sf.mpxj.Resource.getOutlineCode8()</a>
<div class="block"><span class="deprecationComment">use getOutlineCode(8)</span></div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colOne"><a href="net/sf/mpxj/Resource.html#getOutlineCode9--">net.sf.mpxj.Resource.getOutlineCode9()</a>
<div class="block"><span class="deprecationComment">use getOutlineCode(9)</span></div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colOne"><a href="net/sf/mpxj/ProjectCalendar.html#getResource--">net.sf.mpxj.ProjectCalendar.getResource()</a>
<div class="block"><span class="deprecationComment">use getResources method to find resources associated with this calendar</span></div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colOne"><a href="net/sf/mpxj/Resource.html#getResourceCalendar--">net.sf.mpxj.Resource.getResourceCalendar()</a>
<div class="block"><span class="deprecationComment">use getCalendar</span></div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colOne"><a href="net/sf/mpxj/Resource.html#getResourceCalendarUniqueID--">net.sf.mpxj.Resource.getResourceCalendarUniqueID()</a>
<div class="block"><span class="deprecationComment">use getCalendarUniqueID</span></div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colOne"><a href="net/sf/mpxj/Task.html#getSplitCompleteDuration--">net.sf.mpxj.Task.getSplitCompleteDuration()</a>
<div class="block"><span class="deprecationComment">use getCompleteThrough()</span></div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colOne"><a href="net/sf/mpxj/ProjectFile.html#getStartDate--">net.sf.mpxj.ProjectFile.getStartDate()</a>
<div class="block"><span class="deprecationComment">use ProjectFile.getEarliestStartDate() or ProjectProperties.getStartDate()</span></div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colOne"><a href="net/sf/mpxj/primavera/PrimaveraPMFileReader.html#getWbsIsFullPath--">net.sf.mpxj.primavera.PrimaveraPMFileReader.getWbsIsFullPath()</a></td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="net/sf/mpxj/ProjectProperties.html#setDefaultCalendarName-java.lang.String-">net.sf.mpxj.ProjectProperties.setDefaultCalendarName(String)</a>
<div class="block"><span class="deprecationComment">use `setDefaultCalendar()` or `setDefaultCalendarUniqueID()`</span></div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="net/sf/mpxj/ProjectCalendar.html#setMinutesPerDay-java.lang.Integer-">net.sf.mpxj.ProjectCalendar.setMinutesPerDay(Integer)</a>
<div class="block"><span class="deprecationComment">use setCalendarMinutesPerDay</span></div>
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 10.3.0 API)</title>
<title>API Help (MPXJ 10.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="API Help (MPXJ 10.3.0 API)";
parent.document.title="API Help (MPXJ 10.4.0 API)";
}
}
catch(err) {
Expand Down
Loading

0 comments on commit 1d1c00e

Please sign in to comment.