Skip to content

Commit e6dbd48

Browse files
jonilesjoniles
authored
Restructure docs (#44)
Restructure documentation.
1 parent 3a49885 commit e6dbd48

File tree

75 files changed

+2712
-2029
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+2712
-2029
lines changed

‎docs/apidocs/index-all.html

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -16083,7 +16083,7 @@ <h2 class="title">G</h2>
1608316083
<dd>
1608416084
<div class="block">Retrieves the vendor of the file used to populate this ProjectFile instance.</div>
1608516085
</dd>
16086-
<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>
16086+
<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>
1608716087
<dd>
1608816088
<div class="block">This method allows us to peek into the OLE compound document to extract the file format.</div>
1608916089
</dd>
@@ -28760,7 +28760,7 @@ <h2 class="title">G</h2>
2876028760
<div class="block">Retrieves a set containing the file extensions supported by the
2876128761
getProjectWriter method.</div>
2876228762
</dd>
28763-
<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>
28763+
<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>
2876428764
<dd>
2876528765
<div class="block">Retrieves an array of locales supported by this class.</div>
2876628766
</dd>
@@ -31733,10 +31733,6 @@ <h2 class="title">G</h2>
3173331733
<dd>
3173431734
<div class="block">Retrieve the work weeks associated with this calendar.</div>
3173531735
</dd>
31736-
<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>
31737-
<dd>
31738-
<div class="block">Internal only.</div>
31739-
</dd>
3174031736
<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>
3174131737
<dd>
3174231738
<div class="block">Retrieves the state of the flag which controls whether timephased
@@ -49088,7 +49084,7 @@ <h2 class="title">S</h2>
4908849084
</dd>
4908949085
<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>
4909049086
<dd>
49091-
<div class="block">Sets the character encoding used when reading an XER file.</div>
49087+
<div class="block">Sets the character encoding used when reading an MSPDI file.</div>
4909249088
</dd>
4909349089
<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>
4909449090
<dd>
@@ -64612,10 +64608,6 @@ <h2 class="title">S</h2>
6461264608
<dd>
6461364609
<div class="block">Sets the value of the wpDocumentUDFs property.</div>
6461464610
</dd>
64615-
<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>
64616-
<dd>
64617-
<div class="block">Set the write password for this Project file.</div>
64618-
</dd>
6461964611
<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>
6462064612
<dd>
6462164613
<div class="block">Sets a flag to control whether timephased resource assignment data

‎docs/apidocs/net/sf/mpxj/mpp/MPPReader.html

Lines changed: 13 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@
1818
catch(err) {
1919
}
2020
//-->
21-
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};
22-
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
21+
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};
22+
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
2323
var altColor = "altColor";
2424
var rowColor = "rowColor";
2525
var tableTab = "tableTab";
@@ -151,7 +151,7 @@ <h3>Constructor Summary</h3>
151151
</a>
152152
<h3>Method Summary</h3>
153153
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
154-
<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>
154+
<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>
155155
<tr>
156156
<th class="colFirst" scope="col">Modifier and Type</th>
157157
<th class="colLast" scope="col">Method and Description</th>
@@ -163,7 +163,7 @@ <h3>Method Summary</h3>
163163
</td>
164164
</tr>
165165
<tr id="i1" class="rowColor">
166-
<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>
166+
<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>
167167
<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>
168168
<div class="block">This method allows us to peek into the OLE compound document to extract the file format.</div>
169169
</td>
@@ -201,64 +201,52 @@ <h3>Method Summary</h3>
201201
</td>
202202
</tr>
203203
<tr id="i7" class="rowColor">
204-
<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>
205-
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../net/sf/mpxj/mpp/MPPReader.html#getWritePassword--">getWritePassword</a></span>()</code>
206-
<div class="block">Internal only.</div>
207-
</td>
208-
</tr>
209-
<tr id="i8" class="altColor">
210204
<td class="colFirst"><code><a href="../../../../net/sf/mpxj/ProjectFile.html" title="class in net.sf.mpxj">ProjectFile</a></code></td>
211205
<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>
212206
<div class="block">Read a file where the contents of the project file
213207
are supplied via an input stream.</div>
214208
</td>
215209
</tr>
216-
<tr id="i9" class="rowColor">
210+
<tr id="i8" class="altColor">
217211
<td class="colFirst"><code><a href="../../../../net/sf/mpxj/ProjectFile.html" title="class in net.sf.mpxj">ProjectFile</a></code></td>
218212
<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>
219213
<div class="block">Alternative entry point allowing an MPP file to be read from
220214
a user-supplied POI file stream.</div>
221215
</td>
222216
</tr>
223-
<tr id="i10" class="altColor">
217+
<tr id="i9" class="rowColor">
224218
<td class="colFirst"><code>void</code></td>
225219
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../net/sf/mpxj/mpp/MPPReader.html#setPreserveNoteFormatting-boolean-">setPreserveNoteFormatting</a></span>(boolean&nbsp;preserveNoteFormatting)</code>
226220
<div class="block">This method sets a flag to indicate whether the RTF formatting associated
227221
with notes should be preserved or removed.</div>
228222
</td>
229223
</tr>
230-
<tr id="i11" class="rowColor">
224+
<tr id="i10" class="altColor">
231225
<td class="colFirst"><code>void</code></td>
232226
<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>
233227
<div class="block">Set the read password for this Project file.</div>
234228
</td>
235229
</tr>
236-
<tr id="i12" class="altColor">
230+
<tr id="i11" class="rowColor">
237231
<td class="colFirst"><code>void</code></td>
238232
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../net/sf/mpxj/mpp/MPPReader.html#setReadPresentationData-boolean-">setReadPresentationData</a></span>(boolean&nbsp;readPresentationData)</code>
239233
<div class="block">Flag to allow time and memory to be saved by not reading
240234
presentation data from the MPP file.</div>
241235
</td>
242236
</tr>
243-
<tr id="i13" class="rowColor">
237+
<tr id="i12" class="altColor">
244238
<td class="colFirst"><code>void</code></td>
245239
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../net/sf/mpxj/mpp/MPPReader.html#setReadPropertiesOnly-boolean-">setReadPropertiesOnly</a></span>(boolean&nbsp;readPropertiesOnly)</code>
246240
<div class="block">Flag to determine if the reader should only read the project properties.</div>
247241
</td>
248242
</tr>
249-
<tr id="i14" class="altColor">
243+
<tr id="i13" class="rowColor">
250244
<td class="colFirst"><code>void</code></td>
251245
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../net/sf/mpxj/mpp/MPPReader.html#setUseRawTimephasedData-boolean-">setUseRawTimephasedData</a></span>(boolean&nbsp;useRawTimephasedData)</code>
252246
<div class="block">If this flag is true, raw timephased data will be retrieved
253247
from MS Project: no normalisation will take place.</div>
254248
</td>
255249
</tr>
256-
<tr id="i15" class="rowColor">
257-
<td class="colFirst"><code>void</code></td>
258-
<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>
259-
<div class="block">Set the write password for this Project file.</div>
260-
</td>
261-
</tr>
262250
</table>
263251
<ul class="blockList">
264252
<li class="blockList"><a name="methods.inherited.from.class.net.sf.mpxj.reader.AbstractProjectReader">
@@ -345,8 +333,8 @@ <h4>read</h4>
345333
<ul class="blockList">
346334
<li class="blockList">
347335
<h4>getFileFormat</h4>
348-
<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)
349-
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>
336+
<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)
337+
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>
350338
<div class="block">This method allows us to peek into the OLE compound document to extract the file format.
351339
This allows the UniversalProjectReader to determine if this is an MPP file, or if
352340
it is another type of OLE compound document.</div>
@@ -522,7 +510,7 @@ <h4>setReadPassword</h4>
522510
<a name="getReadPassword--">
523511
<!-- -->
524512
</a>
525-
<ul class="blockList">
513+
<ul class="blockListLast">
526514
<li class="blockList">
527515
<h4>getReadPassword</h4>
528516
<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>
@@ -534,37 +522,6 @@ <h4>getReadPassword</h4>
534522
</dl>
535523
</li>
536524
</ul>
537-
<a name="setWritePassword-java.lang.String-">
538-
<!-- -->
539-
</a>
540-
<ul class="blockList">
541-
<li class="blockList">
542-
<h4>setWritePassword</h4>
543-
<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>
544-
<div class="block">Set the write password for this Project file. Currently not used.
545-
546-
Note: Set this each time before calling the read method.</div>
547-
<dl>
548-
<dt><span class="paramLabel">Parameters:</span></dt>
549-
<dd><code>password</code> - password text</dd>
550-
</dl>
551-
</li>
552-
</ul>
553-
<a name="getWritePassword--">
554-
<!-- -->
555-
</a>
556-
<ul class="blockListLast">
557-
<li class="blockList">
558-
<h4>getWritePassword</h4>
559-
<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>
560-
<div class="block">Internal only. Get the write password for this Project file.
561-
Currently not used.</div>
562-
<dl>
563-
<dt><span class="returnLabel">Returns:</span></dt>
564-
<dd>password</dd>
565-
</dl>
566-
</li>
567-
</ul>
568525
</li>
569526
</ul>
570527
</li>

‎docs/apidocs/net/sf/mpxj/mpx/MPXReader.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@
1818
catch(err) {
1919
}
2020
//-->
21-
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10};
22-
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
21+
var methods = {"i0":10,"i1":10,"i2":10,"i3":9,"i4":10,"i5":10,"i6":10};
22+
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
2323
var altColor = "altColor";
2424
var rowColor = "rowColor";
2525
var tableTab = "tableTab";
@@ -173,7 +173,7 @@ <h3>Constructor Summary</h3>
173173
</a>
174174
<h3>Method Summary</h3>
175175
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
176-
<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>
176+
<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>
177177
<tr>
178178
<th class="colFirst" scope="col">Modifier and Type</th>
179179
<th class="colLast" scope="col">Method and Description</th>
@@ -198,7 +198,7 @@ <h3>Method Summary</h3>
198198
</td>
199199
</tr>
200200
<tr id="i3" class="rowColor">
201-
<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>
201+
<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>
202202
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../net/sf/mpxj/mpx/MPXReader.html#getSupportedLocales--">getSupportedLocales</a></span>()</code>
203203
<div class="block">Retrieves an array of locales supported by this class.</div>
204204
</td>
@@ -337,7 +337,7 @@ <h4>setLocale</h4>
337337
<ul class="blockList">
338338
<li class="blockList">
339339
<h4>getSupportedLocales</h4>
340-
<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>
340+
<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>
341341
<div class="block">Retrieves an array of locales supported by this class.</div>
342342
<dl>
343343
<dt><span class="returnLabel">Returns:</span></dt>

‎docs/apidocs/net/sf/mpxj/mspdi/MSPDIReader.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ <h3>Method Summary</h3>
185185
<tr id="i4" class="altColor">
186186
<td class="colFirst"><code>void</code></td>
187187
<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>
188-
<div class="block">Sets the character encoding used when reading an XER file.</div>
188+
<div class="block">Sets the character encoding used when reading an MSPDI file.</div>
189189
</td>
190190
</tr>
191191
<tr id="i5" class="rowColor">
@@ -248,7 +248,7 @@ <h3>Method Detail</h3>
248248
<li class="blockList">
249249
<h4>setEncoding</h4>
250250
<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>
251-
<div class="block">Sets the character encoding used when reading an XER file.</div>
251+
<div class="block">Sets the character encoding used when reading an MSPDI file.</div>
252252
<dl>
253253
<dt><span class="paramLabel">Parameters:</span></dt>
254254
<dd><code>encoding</code> - encoding name</dd>

0 commit comments

Comments
 (0)