Skip to content

Commit

Permalink
Restructure docs (#44)
Browse files Browse the repository at this point in the history 
Restructure documentation.
  • Loading branch information
@joniles
joniles committed Apr 29, 2018
1 parent 3a49885 commit e6dbd48
Show file tree
Hide file tree
Showing 75 changed files with 2,712 additions and 2,029 deletions.
14 changes: 3 additions & 11 deletions docs/apidocs/index-all.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16083,7 +16083,7 @@ <h2 class="title">G</h2>
<dd>
<div class="block">Retrieves the vendor of the file used to populate this ProjectFile instance.</div>
</dd>
<dt><span class="memberNameLink"><a href="net/sf/mpxj/mpp/MPPReader.html#getFileFormat-org.apache.poi.poifs.filesystem.POIFSFileSystem-">getFileFormat(POIFSFileSystem)</a></span> - Method in class net.sf.mpxj.mpp.<a href="net/sf/mpxj/mpp/MPPReader.html" title="class in net.sf.mpxj.mpp">MPPReader</a></dt>
<dt><span class="memberNameLink"><a href="net/sf/mpxj/mpp/MPPReader.html#getFileFormat-org.apache.poi.poifs.filesystem.POIFSFileSystem-">getFileFormat(POIFSFileSystem)</a></span> - Static method in class net.sf.mpxj.mpp.<a href="net/sf/mpxj/mpp/MPPReader.html" title="class in net.sf.mpxj.mpp">MPPReader</a></dt>
<dd>
<div class="block">This method allows us to peek into the OLE compound document to extract the file format.</div>
</dd>
Expand Down Expand Up @@ -28760,7 +28760,7 @@ <h2 class="title">G</h2>
<div class="block">Retrieves a set containing the file extensions supported by the
getProjectWriter method.</div>
</dd>
<dt><span class="memberNameLink"><a href="net/sf/mpxj/mpx/MPXReader.html#getSupportedLocales--">getSupportedLocales()</a></span> - Method in class net.sf.mpxj.mpx.<a href="net/sf/mpxj/mpx/MPXReader.html" title="class in net.sf.mpxj.mpx">MPXReader</a></dt>
<dt><span class="memberNameLink"><a href="net/sf/mpxj/mpx/MPXReader.html#getSupportedLocales--">getSupportedLocales()</a></span> - Static method in class net.sf.mpxj.mpx.<a href="net/sf/mpxj/mpx/MPXReader.html" title="class in net.sf.mpxj.mpx">MPXReader</a></dt>
<dd>
<div class="block">Retrieves an array of locales supported by this class.</div>
</dd>
Expand Down Expand Up @@ -31733,10 +31733,6 @@ <h2 class="title">G</h2>
<dd>
<div class="block">Retrieve the work weeks associated with this calendar.</div>
</dd>
<dt><span class="memberNameLink"><a href="net/sf/mpxj/mpp/MPPReader.html#getWritePassword--">getWritePassword()</a></span> - Method in class net.sf.mpxj.mpp.<a href="net/sf/mpxj/mpp/MPPReader.html" title="class in net.sf.mpxj.mpp">MPPReader</a></dt>
<dd>
<div class="block">Internal only.</div>
</dd>
<dt><span class="memberNameLink"><a href="net/sf/mpxj/mspdi/MSPDIWriter.html#getWriteTimephasedData--">getWriteTimephasedData()</a></span> - Method in class net.sf.mpxj.mspdi.<a href="net/sf/mpxj/mspdi/MSPDIWriter.html" title="class in net.sf.mpxj.mspdi">MSPDIWriter</a></dt>
<dd>
<div class="block">Retrieves the state of the flag which controls whether timephased
Expand Down Expand Up @@ -49088,7 +49084,7 @@ <h2 class="title">S</h2>
</dd>
<dt><span class="memberNameLink"><a href="net/sf/mpxj/mspdi/MSPDIReader.html#setEncoding-java.lang.String-">setEncoding(String)</a></span> - Method in class net.sf.mpxj.mspdi.<a href="net/sf/mpxj/mspdi/MSPDIReader.html" title="class in net.sf.mpxj.mspdi">MSPDIReader</a></dt>
<dd>
<div class="block">Sets the character encoding used when reading an XER file.</div>
<div class="block">Sets the character encoding used when reading an MSPDI file.</div>
</dd>
<dt><span class="memberNameLink"><a href="net/sf/mpxj/planner/PlannerWriter.html#setEncoding-java.lang.String-">setEncoding(String)</a></span> - Method in class net.sf.mpxj.planner.<a href="net/sf/mpxj/planner/PlannerWriter.html" title="class in net.sf.mpxj.planner">PlannerWriter</a></dt>
<dd>
Expand Down Expand Up @@ -64612,10 +64608,6 @@ <h2 class="title">S</h2>
<dd>
<div class="block">Sets the value of the wpDocumentUDFs property.</div>
</dd>
<dt><span class="memberNameLink"><a href="net/sf/mpxj/mpp/MPPReader.html#setWritePassword-java.lang.String-">setWritePassword(String)</a></span> - Method in class net.sf.mpxj.mpp.<a href="net/sf/mpxj/mpp/MPPReader.html" title="class in net.sf.mpxj.mpp">MPPReader</a></dt>
<dd>
<div class="block">Set the write password for this Project file.</div>
</dd>
<dt><span class="memberNameLink"><a href="net/sf/mpxj/mspdi/MSPDIWriter.html#setWriteTimephasedData-boolean-">setWriteTimephasedData(boolean)</a></span> - Method in class net.sf.mpxj.mspdi.<a href="net/sf/mpxj/mspdi/MSPDIWriter.html" title="class in net.sf.mpxj.mspdi">MSPDIWriter</a></dt>
<dd>
<div class="block">Sets a flag to control whether timephased resource assignment data
Expand Down
69 changes: 13 additions & 56 deletions docs/apidocs/net/sf/mpxj/mpp/MPPReader.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var methods = {"i0":10,"i1":9,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
Expand Down Expand Up @@ -151,7 +151,7 @@ <h3>Constructor Summary</h3>
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
Expand All @@ -163,7 +163,7 @@ <h3>Method Summary</h3>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../net/sf/mpxj/mpp/MPPReader.html#getFileFormat-org.apache.poi.poifs.filesystem.POIFSFileSystem-">getFileFormat</a></span>(org.apache.poi.poifs.filesystem.POIFSFileSystem&nbsp;fs)</code>
<div class="block">This method allows us to peek into the OLE compound document to extract the file format.</div>
</td>
Expand Down Expand Up @@ -201,64 +201,52 @@ <h3>Method Summary</h3>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../net/sf/mpxj/mpp/MPPReader.html#getWritePassword--">getWritePassword</a></span>()</code>
<div class="block">Internal only.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../net/sf/mpxj/ProjectFile.html" title="class in net.sf.mpxj">ProjectFile</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../net/sf/mpxj/mpp/MPPReader.html#read-java.io.InputStream-">read</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;is)</code>
<div class="block">Read a file where the contents of the project file
are supplied via an input stream.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../net/sf/mpxj/ProjectFile.html" title="class in net.sf.mpxj">ProjectFile</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../net/sf/mpxj/mpp/MPPReader.html#read-org.apache.poi.poifs.filesystem.POIFSFileSystem-">read</a></span>(org.apache.poi.poifs.filesystem.POIFSFileSystem&nbsp;fs)</code>
<div class="block">Alternative entry point allowing an MPP file to be read from
a user-supplied POI file stream.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../net/sf/mpxj/mpp/MPPReader.html#setPreserveNoteFormatting-boolean-">setPreserveNoteFormatting</a></span>(boolean&nbsp;preserveNoteFormatting)</code>
<div class="block">This method sets a flag to indicate whether the RTF formatting associated
with notes should be preserved or removed.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../net/sf/mpxj/mpp/MPPReader.html#setReadPassword-java.lang.String-">setReadPassword</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;password)</code>
<div class="block">Set the read password for this Project file.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../net/sf/mpxj/mpp/MPPReader.html#setReadPresentationData-boolean-">setReadPresentationData</a></span>(boolean&nbsp;readPresentationData)</code>
<div class="block">Flag to allow time and memory to be saved by not reading
presentation data from the MPP file.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../net/sf/mpxj/mpp/MPPReader.html#setReadPropertiesOnly-boolean-">setReadPropertiesOnly</a></span>(boolean&nbsp;readPropertiesOnly)</code>
<div class="block">Flag to determine if the reader should only read the project properties.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../net/sf/mpxj/mpp/MPPReader.html#setUseRawTimephasedData-boolean-">setUseRawTimephasedData</a></span>(boolean&nbsp;useRawTimephasedData)</code>
<div class="block">If this flag is true, raw timephased data will be retrieved
from MS Project: no normalisation will take place.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../net/sf/mpxj/mpp/MPPReader.html#setWritePassword-java.lang.String-">setWritePassword</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;password)</code>
<div class="block">Set the write password for this Project file.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.net.sf.mpxj.reader.AbstractProjectReader">
Expand Down Expand Up @@ -345,8 +333,8 @@ <h4>read</h4>
<ul class="blockList">
<li class="blockList">
<h4>getFileFormat</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getFileFormat(org.apache.poi.poifs.filesystem.POIFSFileSystem&nbsp;fs)
throws <a href="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<pre>public static&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getFileFormat(org.apache.poi.poifs.filesystem.POIFSFileSystem&nbsp;fs)
throws <a href="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">This method allows us to peek into the OLE compound document to extract the file format.
This allows the UniversalProjectReader to determine if this is an MPP file, or if
it is another type of OLE compound document.</div>
Expand Down Expand Up @@ -522,7 +510,7 @@ <h4>setReadPassword</h4>
<a name="getReadPassword--">
<!-- -->
</a>
<ul class="blockList">
<ul class="blockListLast">
<li class="blockList">
<h4>getReadPassword</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getReadPassword()</pre>
Expand All @@ -534,37 +522,6 @@ <h4>getReadPassword</h4>
</dl>
</li>
</ul>
<a name="setWritePassword-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setWritePassword</h4>
<pre>public&nbsp;void&nbsp;setWritePassword(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;password)</pre>
<div class="block">Set the write password for this Project file. Currently not used.

Note: Set this each time before calling the read method.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>password</code> - password text</dd>
</dl>
</li>
</ul>
<a name="getWritePassword--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getWritePassword</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getWritePassword()</pre>
<div class="block">Internal only. Get the write password for this Project file.
Currently not used.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>password</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
Expand Down
10 changes: 5 additions & 5 deletions docs/apidocs/net/sf/mpxj/mpx/MPXReader.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var methods = {"i0":10,"i1":10,"i2":10,"i3":9,"i4":10,"i5":10,"i6":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
Expand Down Expand Up @@ -173,7 +173,7 @@ <h3>Constructor Summary</h3>
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
Expand All @@ -198,7 +198,7 @@ <h3>Method Summary</h3>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a>[]</code></td>
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../net/sf/mpxj/mpx/MPXReader.html#getSupportedLocales--">getSupportedLocales</a></span>()</code>
<div class="block">Retrieves an array of locales supported by this class.</div>
</td>
Expand Down Expand Up @@ -337,7 +337,7 @@ <h4>setLocale</h4>
<ul class="blockList">
<li class="blockList">
<h4>getSupportedLocales</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a>[]&nbsp;getSupportedLocales()</pre>
<pre>public static&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a>[]&nbsp;getSupportedLocales()</pre>
<div class="block">Retrieves an array of locales supported by this class.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
Expand Down
4 changes: 2 additions & 2 deletions docs/apidocs/net/sf/mpxj/mspdi/MSPDIReader.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ <h3>Method Summary</h3>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../net/sf/mpxj/mspdi/MSPDIReader.html#setEncoding-java.lang.String-">setEncoding</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;encoding)</code>
<div class="block">Sets the character encoding used when reading an XER file.</div>
<div class="block">Sets the character encoding used when reading an MSPDI file.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
Expand Down Expand Up @@ -248,7 +248,7 @@ <h3>Method Detail</h3>
<li class="blockList">
<h4>setEncoding</h4>
<pre>public&nbsp;void&nbsp;setEncoding(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;encoding)</pre>
<div class="block">Sets the character encoding used when reading an XER file.</div>
<div class="block">Sets the character encoding used when reading an MSPDI file.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>encoding</code> - encoding name</dd>
Expand Down
Loading

0 comments on commit e6dbd48

Please sign in to comment.