Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@joniles
joniles committed Jan 6, 2025
1 parent e615cf4 commit 408a7e1
Show file tree
Hide file tree
Showing 2,153 changed files with 5,266 additions and 3,062 deletions.
3 changes: 2 additions & 1 deletion CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ no longer be distributed. Please use the `MPXJ.Net` package instead.


## 13.9.0 (unreleased)
* Updated PMXML schema to version 24.12.

## 13.8.0 (2024-12-17)
* Added support for reading and writing Project Codes, Resource Codes, Role Codes and Resource Assignment Codes for Primavera P6 schedules.
Expand Down Expand Up @@ -114,7 +115,7 @@ no longer be distributed. Please use the `MPXJ.Net` package instead.

## 13.0.0 (2024-06-20)
* NOTE: this is a major release containing breaking changes. When updating from a 12.x release it is recommended that you first update to the most recent 12.x release and deal with any deprecation warnings before moving to this release.
* NOTE: the [original `net.sf.mpxj` NuGet packages](https://www.nuget.org/packages?q=net.sf.mpxj) are now deprecated and will be replaced by the [MPXJ.Net NuGet Package](https://www.nuget.org/packages/MPXJ.Net) in the next major MPXJ release. The `net.sf.mpxj` packages will continue to be maintained until then, at which point they will no longer be distributed. Please migrate your code to use MPXJ.Net at the earliest opportunity, and open an issue in the GitHUb issue tracker if you encounter problems.
* NOTE: the [original `net.sf.mpxj` NuGet packages](https://www.nuget.org/packages?q=net.sf.mpxj) are now deprecated and will be replaced by the [MPXJ.Net NuGet Package](https://www.nuget.org/packages/MPXJ.Net) in the next major MPXJ release. The `net.sf.mpxj` packages will continue to be maintained until then, at which point they will no longer be distributed. Please migrate your code to use MPXJ.Net at the earliest opportunity, and open an issue in the GitHub issue tracker if you encounter problems.
* Updated to use JAXB3. Among other things this change ensures compatibility with Spring Boot 3. Note that this may be a breaking change for you if you own application uses JAXB2.
* When reading P6 schedules, the custom properties (as retrieved using `ProjectProperties.getCustomProperties`) will no longer contain scheduling options. These are now all available as attributes of the `ProjectProperties` class.
* Removed redundant `setUniqueID` methods from immutable objects. These previously threw `UnsupportedOperationException` when called.
Expand Down
5 changes: 4 additions & 1 deletion docs/CHANGELOG/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6397,6 +6397,9 @@ <h2 id="note">NOTE</h2>
<p>From version 14.0.0 onwards the <code>net.sf.mpxj</code>, <code>net.sf.mpxj-for-csharp</code> and <code>net.sf.mpxj-for-vb</code> packages will
no longer be distributed. Please use the <code>MPXJ.Net</code> package instead.</p>
<h2 id="1390-unreleased">13.9.0 (unreleased)</h2>
<ul>
<li>Updated PMXML schema to version 24.12.</li>
</ul>
<h2 id="1380-2024-12-17">13.8.0 (2024-12-17)</h2>
<ul>
<li>Added support for reading and writing Project Codes, Resource Codes, Role Codes and Resource Assignment Codes for Primavera P6 schedules.</li>
Expand Down Expand Up @@ -6521,7 +6524,7 @@ <h2 id="1301-2024-07-04">13.0.1 (2024-07-04)</h2>
<h2 id="1300-2024-06-20">13.0.0 (2024-06-20)</h2>
<ul>
<li>NOTE: this is a major release containing breaking changes. When updating from a 12.x release it is recommended that you first update to the most recent 12.x release and deal with any deprecation warnings before moving to this release.</li>
<li>NOTE: the <a href="https://www.nuget.org/packages?q=net.sf.mpxj">original <code>net.sf.mpxj</code> NuGet packages</a> are now deprecated and will be replaced by the <a href="https://www.nuget.org/packages/MPXJ.Net">MPXJ.Net NuGet Package</a> in the next major MPXJ release. The <code>net.sf.mpxj</code> packages will continue to be maintained until then, at which point they will no longer be distributed. Please migrate your code to use MPXJ.Net at the earliest opportunity, and open an issue in the GitHUb issue tracker if you encounter problems.</li>
<li>NOTE: the <a href="https://www.nuget.org/packages?q=net.sf.mpxj">original <code>net.sf.mpxj</code> NuGet packages</a> are now deprecated and will be replaced by the <a href="https://www.nuget.org/packages/MPXJ.Net">MPXJ.Net NuGet Package</a> in the next major MPXJ release. The <code>net.sf.mpxj</code> packages will continue to be maintained until then, at which point they will no longer be distributed. Please migrate your code to use MPXJ.Net at the earliest opportunity, and open an issue in the GitHub issue tracker if you encounter problems.</li>
<li>Updated to use JAXB3. Among other things this change ensures compatibility with Spring Boot 3. Note that this may be a breaking change for you if you own application uses JAXB2.</li>
<li>When reading P6 schedules, the custom properties (as retrieved using <code>ProjectProperties.getCustomProperties</code>) will no longer contain scheduling options. These are now all available as attributes of the <code>ProjectProperties</code> class.</li>
<li>Removed redundant <code>setUniqueID</code> methods from immutable objects. These previously threw <code>UnsupportedOperationException</code> when called.</li>
Expand Down
1 change: 1 addition & 0 deletions docs/apidocs/allclasses-frame.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -529,6 +529,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="net/sf/mpxj/primavera/p3/P3PRXFileReader.html" title="class in net.sf.mpxj.primavera.p3" target="classFrame">P3PRXFileReader</a></li>
<li><a href="net/sf/mpxj/common/Pair.html" title="class in net.sf.mpxj.common" target="classFrame">Pair</a></li>
<li><a href="net/sf/mpxj/ParentNotes.html" title="class in net.sf.mpxj" target="classFrame">ParentNotes</a></li>
<li><a href="net/sf/mpxj/primavera/schema/PAuditXType.html" title="class in net.sf.mpxj.primavera.schema" target="classFrame">PAuditXType</a></li>
<li><a href="net/sf/mpxj/PercentCompleteType.html" title="enum in net.sf.mpxj" target="classFrame">PercentCompleteType</a></li>
<li><a href="net/sf/mpxj/planner/schema/Phase.html" title="class in net.sf.mpxj.planner.schema" target="classFrame">Phase</a></li>
<li><a href="net/sf/mpxj/planner/schema/Phases.html" title="class in net.sf.mpxj.planner.schema" target="classFrame">Phases</a></li>
Expand Down
1 change: 1 addition & 0 deletions docs/apidocs/allclasses-noframe.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -529,6 +529,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="net/sf/mpxj/primavera/p3/P3PRXFileReader.html" title="class in net.sf.mpxj.primavera.p3">P3PRXFileReader</a></li>
<li><a href="net/sf/mpxj/common/Pair.html" title="class in net.sf.mpxj.common">Pair</a></li>
<li><a href="net/sf/mpxj/ParentNotes.html" title="class in net.sf.mpxj">ParentNotes</a></li>
<li><a href="net/sf/mpxj/primavera/schema/PAuditXType.html" title="class in net.sf.mpxj.primavera.schema">PAuditXType</a></li>
<li><a href="net/sf/mpxj/PercentCompleteType.html" title="enum in net.sf.mpxj">PercentCompleteType</a></li>
<li><a href="net/sf/mpxj/planner/schema/Phase.html" title="class in net.sf.mpxj.planner.schema">Phase</a></li>
<li><a href="net/sf/mpxj/planner/schema/Phases.html" title="class in net.sf.mpxj.planner.schema">Phases</a></li>
Expand Down
2 changes: 1 addition & 1 deletion docs/apidocs/constant-values.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -961,6 +961,6 @@ <h2 title="net.sf">net.sf.*</h2>
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2000&#x2013;2024 <a href="http://mpxj.org">Packwood Software</a>. All rights reserved.</small></p>
<p class="legalCopy"><small>Copyright &#169; 2000&#x2013;2025 <a href="http://mpxj.org">Packwood Software</a>. All rights reserved.</small></p>
</body>
</html>
2 changes: 1 addition & 1 deletion docs/apidocs/deprecated-list.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -257,6 +257,6 @@ <h2 title="Contents">Contents</h2>
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2000&#x2013;2024 <a href="http://mpxj.org">Packwood Software</a>. All rights reserved.</small></p>
<p class="legalCopy"><small>Copyright &#169; 2000&#x2013;2025 <a href="http://mpxj.org">Packwood Software</a>. All rights reserved.</small></p>
</body>
</html>
2 changes: 1 addition & 1 deletion docs/apidocs/help-doc.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,6 @@ <h2>Constant Field Values</h2>
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2000&#x2013;2024 <a href="http://mpxj.org">Packwood Software</a>. All rights reserved.</small></p>
<p class="legalCopy"><small>Copyright &#169; 2000&#x2013;2025 <a href="http://mpxj.org">Packwood Software</a>. All rights reserved.</small></p>
</body>
</html>
Loading

0 comments on commit 408a7e1

Please sign in to comment.