[Libreoffice-commits] core.git: Branch 'feature/doxygen' - 15 commits - odk/CustomTarget_autodoc.mk odk/CustomTarget_check.mk odk/docs odk/examples odk/index.html odk/index_online.html odk/Module_odk.mk odk/Package_autodoc.mk odk/Package_bin.mk odk/Package_docs.mk odk/PackageSet_autodoc.mk odk/util odk/Zip_cppdocs.mk odk/Zip_doxygen.mk offapi/com scp2/source solenv/gbuild udkapi/com
Michael Stahl
mstahl at redhat.com
Sat May 4 11:20:03 PDT 2013
Rebased ref, commits from common ancestor:
commit 7fc39727073ddf7f8d39099a214b45303c5a375a
Author: Michael Stahl <mstahl at redhat.com>
Date: Sat May 4 00:26:01 2013 +0200
odk: fix odd Java example that creates URLs to IDL documentation
... and even does it wrongly by appending the fragment part too early.
Change-Id: I05c790113cb219f422a9650db85c04943cde28a3
diff --git a/odk/examples/java/Inspector/Inspector.java b/odk/examples/java/Inspector/Inspector.java
index a9ceb1c..4b4a46f 100644
--- a/odk/examples/java/Inspector/Inspector.java
+++ b/odk/examples/java/Inspector/Inspector.java
@@ -68,7 +68,7 @@ import org.openoffice.XInstanceInspector;
* registry key (<CODE>__writeRegistryServiceInfo</CODE>).
*/
public class Inspector{
- public static final String sIDLDOCUMENTSUBFOLDER = "docs/common/ref/";
+ public static final String sIDLDOCUMENTSUBFOLDER = "docs/idl/ref/";
/** This class implements the method of the interface XInstanceInspector.
diff --git a/odk/examples/java/Inspector/UnoNode.java b/odk/examples/java/Inspector/UnoNode.java
index 92fef18..55e2257 100644
--- a/odk/examples/java/Inspector/UnoNode.java
+++ b/odk/examples/java/Inspector/UnoNode.java
@@ -145,18 +145,18 @@ public class UnoNode{
sIDLUrl += "/";
}
if (_sClassName.equals("")){
- sIDLUrl += "com/sun/star/module-ix";
+ sIDLUrl += "index";
sAnchor = "";
}
else{
- sIDLUrl += _sClassName.replace('.', '/');
+ sIDLUrl += _sClassName.replace(".", "_1_1");
}
+ sIDLUrl += ".html";
if (sAnchor != null){
if (!sAnchor.equals("")){
sIDLUrl += "#" + sAnchor;
}
}
- sIDLUrl += ".html";
URL openHyperlink = getDispatchURL(".uno:OpenHyperlink");
PropertyValue pv = new PropertyValue();
pv.Name = "URL";
commit 8ef4294d9f3dde5c30bef7af2e9277b04aea28f7
Author: Michael Stahl <mstahl at redhat.com>
Date: Sat May 4 00:21:34 2013 +0200
odk: adapt hyperlinks to IDL docs
Change-Id: I2b1874ff926c7510016919b9f11674a4746fa82c
diff --git a/odk/examples/DevelopersGuide/examples.html b/odk/examples/DevelopersGuide/examples.html
index b33b16e..3d65540 100644
--- a/odk/examples/DevelopersGuide/examples.html
+++ b/odk/examples/DevelopersGuide/examples.html
@@ -338,7 +338,7 @@ of losing connection to LibreOffice %PRODUCT_RELEASE%.</td>
<td class="cell80">Builds a connection to
LibreOffice %PRODUCT_RELEASE% using the URL given on the command line. This example
shows the usage of <a
- href="../../docs/common/ref/com/sun/star/bridge/XUnoUrlResolver.html"
+ href="../../docs/idl/ref/com_1_1sun_1_1star_1_1bridge_1_1XUnoUrlResolver.html"
title="link to the reference documentation of com.sun.star.bridge.XUnoResolver"><code>XUnoUrlResolver</code></a>.</td>
</tr>
</tbody>
@@ -615,10 +615,10 @@ components.</td>
title="link to Components/JavaComponent/TestComponentA.java">TestComponentA</a></td>
<td class="cell80">Shows a simple demo component
which implements <a
- href="../../docs/common/ref/com/sun/star/lang/XTypeProvider.html"
+ href="../../docs/idl/ref/com_1_1sun_1_1star_1_1lang_1_1XTypeProvider.html"
title="link to the reference documentation of com.sun.star.lang.XTypeProvider"><code>XTypeProvider</code></a>,
<a
- href="../../docs/common/ref/com/sun/star/lang/XServiceInfo.html"
+ href="../../docs/idl/ref/com_1_1sun_1_1star_1_1lang_1_1XServiceInfo.html"
title="link to the reference documentation of com.sun.star.lang.XServicedInfo">
<code>XServiceInfo</code></a> and an own interface <code>XSomethingA</code>.</td>
</tr>
@@ -628,10 +628,10 @@ which implements <a
title="link to Components/JavaComponent/TestComponentB.java">TestComponentB</a></td>
<td class="cell80">Shows a simple demo component
which implements <a
- href="../../docs/common/ref/com/sun/star/lang/XTypeProvider.html"
+ href="../../docs/idl/ref/com_1_1sun_1_1star_1_1lang_1_1XTypeProvider.html"
title="link to the reference documentation of com.sun.star.lang.XTypeProvider">
<code>XTypeProvider</code></a>, <a
- href="../../docs/common/ref/com/sun/star/lang/XServiceInfo.html"
+ href="../../docs/idl/ref/com_1_1sun_1_1star_1_1lang_1_1XServiceInfo.html"
title="link to the reference documentation of com.sun.star.lang.XServiceInfo"><code>XServiceInfo</code></a>
and an own interface <code>XSomethingB</code>.</td>
</tr>
@@ -982,7 +982,7 @@ interceptor for a specific URL.</td>
href="./OfficeDev/DesktopEnvironment/JavaWindowPeerFake.java"
title="link to OfficeDev/DesktopEnvironment/JavaWindowPeerFake.java">JavaWindowPeerFake</a></td>
<td class="cell80">Fakes an <a
- href="../../docs/common/ref/com/sun/star/awt/XWindowPeer.html"
+ href="../../docs/idl/ref/com_1_1sun_1_1star_1_1awt_1_1XWindowPeer.html"
title=" link to the reference documentation of com.sun.star.awt.XWindowPeer"><code>XWindowPeer</code></a>
for the Java native window handle to create a child window for the
office frame.</td>
@@ -1014,7 +1014,7 @@ to decouple asynchronous oneway calls in the Java process.</td>
href="./OfficeDev/DesktopEnvironment/StatusListener.java"
title="link to OfficeDev/DesktopEnvironment/StatusListener.java">StatusListener</a></td>
<td class="cell80">Implements a listener for a <a
- href="../../docs/common/ref/com/sun/star/frame/FeatureStateEvent.html"
+ href="../../docs/idl/ref/com_1_1sun_1_1star_1_1frame_1_1FeatureStateEvent.html"
title="link to the reference documentation of com.sun.star.frame.FeatureStateEvent">
<code>FeatureStateEvent</code></a>.</td>
</tr>
@@ -1102,7 +1102,7 @@ TerminateListener and shows the use of them in a running program.</td>
href="./OfficeDev/TerminationTest/TerminateListener.java"
title="link to OfficeDev/TerminationTest/TerminateListener.java">TerminateListener</a></td>
<td class="cell80">An example implementation of <a
- href="../../docs/common/ref/com/sun/star/frame/XTerminateListener.html"
+ href="../../docs/idl/ref/com_1_1sun_1_1star_1_1frame_1_1XTerminateListener.html"
title="link to the reference documentation of com.sun.star.frame.XTerminationListener">
<code>XTerminateListener</code></a>. It is called
when LibreOffice %PRODUCT_RELEASE% terminates.</td>
@@ -1213,7 +1213,7 @@ tracking the spell checking relevant properties.</td>
href="./OfficeDev/Linguistic/SampleHyphenator.java"
title="link to OfficeDev/Linguistic/SampleHyphenator.java">SampleHyphenator</a></td>
<td class="cell80">A simple implementation for a <a
- href="../../docs/common/ref/com/sun/star/linguistic2/Hyphenator.html"
+ href="../../docs/idl/ref/com_1_1sun_1_1star_1_1linguistic2_1_1Hyphenator.html"
title="link to the reference documentation of com.sun.star.linguistic2.Hypenator"><code>Hyphenator</code></a>
service.</td>
</tr>
@@ -1224,7 +1224,7 @@ service.</td>
href="./OfficeDev/Linguistic/SampleSpellChecker.java"
title="link to OfficeDev/Linguistic/SampleSpellChecker.java">SampleSpellChecker</a></td>
<td class="cell80">A simple implementation for a <a
- href="../../docs/common/ref/com/sun/star/linguistic2/SpellChecker.html"
+ href="../../docs/idl/ref/com_1_1sun_1_1star_1_1linguistic2_1_1SpellChecker.html"
title="link to the reference documentation of com.sun.star.linguistic2.SpellChecker"><code>SpellChecker</code></a>
service.</td>
</tr>
@@ -1235,7 +1235,7 @@ service.</td>
href="./OfficeDev/Linguistic/SampleThesaurus.java"
title="link to OfficeDev/Linguistic/SampleThesaurus.java">SampleThesaurus</a></td>
<td class="cell80">A simple implementation for a <a
- href="../../docs/common/ref/com/sun/star/linguistic2/Thesaurus.html"
+ href="../../docs/idl/ref/com_1_1sun_1_1star_1_1linguistic2_1_1Thesaurus.html"
title="link to the reference documentation of com.sun.star.linguistic2.Thesaurus"><code>Thesaurus</code></a>
service.</td>
</tr>
@@ -1246,7 +1246,7 @@ service.</td>
href="./OfficeDev/Linguistic/XHyphenatedWord_impl.java"
title="link to OfficeDev/Linguistic/XHyphenatedWord_impl.java">XHyphenatedWord_impl</a></td>
<td class="cell80">An object implementing the <a
- href="../../docs/common/ref/com/sun/star/linguistic2/XHyphenatedWord.html"
+ href="../../docs/idl/ref/com_1_1sun_1_1star_1_1linguistic2_1_1XHyphenatedWord.html"
title="link to the reference documentation of com.sun.star.linguistic2/XHyphenatedWord"><code>XHyphenatedWord</code></a>
interface. An instance of this type may be returned by the hyphenator.</td>
</tr>
@@ -1257,7 +1257,7 @@ interface. An instance of this type may be returned by the hyphenator.</td>
href="./OfficeDev/Linguistic/XMeaning_impl.java"
title="link to OfficeDev/Linguistic/XMeaning_impl.java">XMeaning_impl</a></td>
<td class="cell80">An object implementing the <a
- href="../../docs/common/ref/com/sun/star/linguistic2/XMeaning.html"
+ href="../../docs/idl/ref/com_1_1sun_1_1star_1_1linguistic2_1_1XMeaning.html"
title="link to the reference documentation of com.sun.star.linguistic2.XMeaning"><code>XMeaning</code></a>
interface. An instance of this type may be returned by the thesaurus.</td>
</tr>
@@ -1268,7 +1268,7 @@ interface. An instance of this type may be returned by the thesaurus.</td>
href="./OfficeDev/Linguistic/XPossibleHyphens_impl.java"
title="link to OfficeDev/Linguistic/XPossibleHyphens_impl.java">XPossibleHyphens_impl</a></td>
<td class="cell80">An object implementing the <a
- href="../../docs/common/ref/com/sun/star/linguistic2/XPossibleHyphens.html"
+ href="../../docs/idl/ref/com_1_1sun_1_1star_1_1linguistic2_1_1XPossibleHyphens.html"
title="link to the reference documentation of com.sun.star.linguistic2.XPossibleHyphens">
<code>XPossibleHyphens</code></a> interface. An
instance of this type may be returned by the hyphenator.</td>
@@ -1280,7 +1280,7 @@ instance of this type may be returned by the hyphenator.</td>
href="./OfficeDev/Linguistic/XSpellAlternatives_impl.java"
title="link to OfficeDev/Linguistic/XSpellAlternatives_impl.java">XSpellAlternatives_impl</a></td>
<td class="cell80">An object implementing the <a
- href="../../docs/common/ref/com/sun/star/linguistic2/XSpellAlternatives.html"
+ href="../../docs/idl/ref/com_1_1sun_1_1star_1_1linguistic2_1_1XSpellAlternatives.html"
title="link to the reference documentation of com.sun.star.linguistic2.XSpellAlternatives">
<code>XSpellAlternatives</code></a> interface. An
instance of this type may be returned by the spell checker.</td>
@@ -1305,12 +1305,12 @@ instance of this type may be returned by the spell checker.</td>
title="link to OfficeDev/PathSettings/PathSettingsTest.java">PathsettingsTest</a></td>
<td class="cell80">This code example creates the
service <a
- href="../../docs/common/ref/com/sun/star/util/PathSettings.html"
+ href="../../docs/idl/ref/com_1_1sun_1_1star_1_1util_1_1PathSettings.html"
title="link to the reference documentation of com.sun.star.util.PathSettingst">
<code>com.sun.star.util.PathSettings</code></a> and
retrieves all path properties from it. It shows how a developer can
change the path properties using the <a
- href="../../docs/common/ref/com/sun/star/beans/XPropertySet.html"
+ href="../../docs/idl/ref/com_1_1sun_1_1star_1_1beans_1_1XPropertySet.html"
title="link to the reference documentation of com.sun.star.beans.XPropertySet"><code>XPropertySet</code></a>
interface.</td>
</tr>
@@ -1332,7 +1332,7 @@ interface.</td>
title="link to OfficeDev/PathSubstitution/PathSubstitutionTest.java">PathSubstitutionTest</a></td>
<td class="cell80">This code example creates the path
substitution service <a
- href="../../docs/common/ref/com/sun/star/util/PathSubstitution.html"
+ href="../../docs/idl/ref/com_1_1sun_1_1star_1_1util_1_1PathSubstitution.html"
title="link to the reference documentation of com.sun.star.util.PathSubstitution">
<code>com.sun.star.util.PathSubstitution</code></a>
and retrieves the pre-defined Office path variables. It shows the
@@ -1492,16 +1492,16 @@ deployed before it can be used.</td>
title="link to Spreadsheet/ExampleDataPilotSource.java">ExampleDataPilotSource</a></td>
<td class="cell80">Shows usage of a wide variety of
spreadsheet interfaces like <a
- href="../../docs/common/ref/com/sun/star/sheet/XCellRangeData.html"
+ href="../../docs/idl/ref/com_1_1sun_1_1star_1_1sheet_1_1XCellRangeData.html"
title="link to the reference documentation of com.sun.star.sheet.XCellRangeData">
<code>XCellRangeData</code></a>, <a
- href="../../docs/common/ref/com/sun/star/sheet/XCellSeries.html"
+ href="../../docs/idl/ref/com_1_1sun_1_1star_1_1sheet_1_1XCellSeries.html"
title="link to the reference documentation of com.sun.star.sheet.XCellSeries"><code>XCellSeries</code></a>,
<a
- href="../../docs/common/ref/com/sun/star/sheet/XArrayFormulaRange.html"
+ href="../../docs/idl/ref/com_1_1sun_1_1star_1_1sheet_1_1XArrayFormulaRange.html"
title="link to the reference documentation of com.sun.star.sheet.XArrayFormularRange"><code>XArrayFormulaRange</code></a>
and <a
- href="../../docs/common/ref/com/sun/star/sheet/XMultipleOperation.html"
+ href="../../docs/idl/ref/com_1_1sun_1_1star_1_1sheet_1_1XMultipleOperation.html"
title="link to the reference documentation of com.sun.star.sheet.XMultipleOperation"><code>XMultipleOperations</code></a>
as well as named ranges, label ranges and data pilot.</td>
</tr>
@@ -1988,9 +1988,9 @@ LibreOffice %PRODUCT_RELEASE% and executes the code SalesMan samples for databas
href="./Database/OpenQuery.java"
title="link to Database/OpenQuery.java">OpenQuery</a></td>
<td class="cell80">Demonstrates the use of <a
- href="../../docs/common/ref/com/sun/star/sdbc/XResultSetUpdate.html"
+ href="../../docs/idl/ref/com_1_1sun_1_1star_1_1sdbc_1_1XResultSetUpdate.html"
title="link to the reference documentation of com.sun.star.sdbc.XResultSetUpdate"><code>XResultSetUpdate</code></a>
-and <a href="../../docs/common/ref/com/sun/star/sdbc/XRowUpdate.html"
+and <a href="../../docs/idl/ref/com_1_1sun_1_1star_1_1sdbc_1_1XRowUpdate.html"
title="link to the reference documentation of com.sun.star.sdbc.XRowUpdate">
<code>XRowUpdate</code></a>.</td>
</tr>
@@ -2221,7 +2221,7 @@ examples</a></td>
title="link to Forms/BooleanValidator.java">BooleanValidator</a></td>
<td class="cell80">The class <code>BooleanOperator</code>
implements an <a
- href="../../docs/common/ref/com/sun/star/form/validation/XValidator.html"
+ href="../../docs/idl/ref/com_1_1sun_1_1star_1_1form_1_1validation_1_1XValidator.html"
title="link to the reference documentation of com.sun.star.form.validation.XValidator">validator</a>
for a form control, which can veto certain radio button or check box
states.</td>
@@ -2240,7 +2240,7 @@ functionality. The class ButtonOperator, well, operates these buttons.</td>
title="link to Forms/ComponentTreeTraversal.java">ComponentTreeTraversal</a></td>
<td class="cell80">Helper classes for traveling
through a tree of <a
- href="../../docs/common/ref/com/sun/star/form/FormComponent.html"
+ href="../../docs/idl/ref/com_1_1sun_1_1star_1_1form_1_1FormComponent.html"
title="link to the reference documentation of com.sun.star.form.FormComponent">
<code>FormComponent's</code></a>.</td>
</tr>
@@ -2249,7 +2249,7 @@ through a tree of <a
title="link to Forms/ControlLock.java">ControlLock</a></td>
<td class="cell80">Helper class for implementing the
locking of control depending on the state of the underlying <a
- href="../../docs/common/ref/com/sun/star/sdb/RowSet.html"
+ href="../../docs/idl/ref/com_1_1sun_1_1star_1_1sdb_1_1RowSet.html"
title="link to the reference documentation of com.sun.star.sdb.RowSet"><code>RowSet</code></a>.</td>
</tr>
<tr>
@@ -2267,7 +2267,7 @@ controls, and attaches several validators to those controls</td>
title="link to Forms/ControlValidator.java">ControlValidator</a></td>
<td class="cell80">Base class implementing the common
denominator for components <a
- href="../../docs/common/ref/com/sun/star/form/validation/ValidatableControlModel.html"
+ href="../../docs/idl/ref/com_1_1sun_1_1star_1_1form_1_1validation_1_1ValidatableControlModel.html"
title="link to the reference documentation of com.sun.star.form.validation.ValidatableControlModel">validating
form controls.</a></td>
</tr>
@@ -2287,7 +2287,7 @@ fields from these tables.</td>
title="link to Forms/DateValidator.java">DateValidator</a></td>
<td class="cell80">The class <code>DateValidator</code>
implements an <a
- href="../../docs/common/ref/com/sun/star/form/validation/XValidator.html"
+ href="../../docs/idl/ref/com_1_1sun_1_1star_1_1form_1_1validation_1_1XValidator.html"
title="link to the reference documentation of com.sun.star.form.validation.XValidator">validator</a>
for a form control, which can check the content of a form date field. </td>
</tr>
@@ -2338,7 +2338,7 @@ manipulating the form layer of a document.</td>
responsible for validating the input in a specific grid control column.
This is not to be mixed up with the control-based validation as
described in the <a
- href="../../docs/common/ref/com/sun/star/form/validation/module-ix.html"
+ href="../../docs/idl/ref/com_1_1sun_1_1star_1_1form_1_1validation.html"
title="link to the reference documentation of com.sun.star.form.validation">validation</a>
module. Instead, a <code>GridFieldValidator</code> assembles and uses
various other concepts.</td>
@@ -2348,7 +2348,7 @@ various other concepts.</td>
href="./Forms/InteractionRequest.java"
title="link to Forms/InteractionRequest.java">InteractionRequest</a></td>
<td class="cell80">A simple implementation of a <a
- href="../../docs/common/ref/com/sun/star/task/XInteractionRequest.html"
+ href="../../docs/idl/ref/com_1_1sun_1_1star_1_1task_1_1XInteractionRequest.html"
title="link to the reference documentation of com.sun.star.task.XInteractionRequest"><code>XInteractionRequest</code></a>.
Not tied to the form layer example, but a general helper.</td>
</tr>
@@ -2357,7 +2357,7 @@ Not tied to the form layer example, but a general helper.</td>
title="link to Forms/KeyGenerator.java">KeyGenerator</a></td>
<td class="cell80">Helper class which is able to
generate (unique) keys for a (<a
- href="../../docs/common/ref/com/sun/star/sdb/RowSet.html"
+ href="../../docs/idl/ref/com_1_1sun_1_1star_1_1sdb_1_1RowSet.html"
title="link to the reference documentation of com.sun.star.sdb.RowSet"><code>RowSet</code>
</a>) column. An instance of this class can be tied
to a specific row set column. It then monitors the state of the
@@ -2371,7 +2371,7 @@ created (two modi, too) key into the column.</td>
title="link to Forms/ListSelectionValidator.java">ListSelectionValidator</a></td>
<td class="cell80">The class <code>ListSelectionValidator</code>
implements an <a
- href="../../docs/common/ref/com/sun/star/form/validation/XValidator.html"
+ href="../../docs/idl/ref/com_1_1sun_1_1star_1_1form/validation_1_1XValidator.html"
title="link to the reference documentation of com.sun.star.form.validation.XValidator">validator</a>
for a form control, which can veto certain selections in a list box
control.</td>
@@ -2382,7 +2382,7 @@ control.</td>
title="link to Forms/NumericValidator.java">NumericValidator</a></td>
<td class="cell80">The class <code>NumericValidator</code>
implements an <a
- href="../../docs/common/ref/com/sun/star/form/validation/XValidator.html"
+ href="../../docs/idl/ref/com_1_1sun_1_1star_1_1form/validation_1_1XValidator.html"
title="link to the reference documentation of com.sun.star.form.validation.XValidator">validator</a>
for a form control, which can veto certain values in every control
which allows exchanging numerical values.</td>
@@ -2394,7 +2394,7 @@ which allows exchanging numerical values.</td>
<td class="cell80">Though form documents feature
inbuilt mechanisms for visually indicating invalid control content (see
<a
- href="../../docs/common/ref/com/sun/star/form/validation/module-ix.html"
+ href="../../docs/idl/ref/com_1_1sun_1_1star_1_1form_1_1validation.html"
title="link to the reference documentation of com.sun.star.form.validation"><code>com.sun.star.form.validation</code>
</a> for discussions about validity), the <a
href="./Forms/ControlValidation.java"
@@ -2413,7 +2413,7 @@ ties together a validatable control and those status texts.</td>
title="link to Forms/DocumentHelper.java"><code>DocumentHelper<code></code></code></a>
which represents a spreadsheet document, and offers some form related
functionality. For instance, this class allows the creation of <a
- href="../../docs/common/ref/com/sun/star/table/CellValueBinding.html"
+ href="../../docs/idl/ref/com_1_1sun_1_1star_1_1table_1_1CellValueBinding.html"
title="link to the reference documentation of com.sun.star.table.CellValueBinding">
<code>CellValueBinding</code></a> instances, which
can be used to couple the content of a form control with the content of
@@ -2443,7 +2443,7 @@ which represents a view to a spreadsheet document.</td>
<td class="cell80">This class allows binding the
control of a form control with a table cell in a text document. For
this, it uses the mechanisms of the <a
- href="../../docs/common/ref/com/sun/star/form/binding/module-ix.html"
+ href="../../docs/idl/ref/com_1_1sun_1_1star_1_1form_1_1binding.html"
title="link to the reference documentation of com.sun.star.form.binding">
<code>com.sun.star.form.binding</code></a> module.</td>
</tr>
@@ -2453,7 +2453,7 @@ this, it uses the mechanisms of the <a
title="link to Forms/TextValidator.java">TextValidator</a></td>
<td class="cell80">The class <code>TextValidator</code>
implements an <a
- href="../../docs/common/ref/com/sun/star/form/validation/XValidator.html"
+ href="../../docs/idl/ref/com_1_1sun_1_1star_1_1form_1_1validation_1_1XValidator.html"
title="link to the reference documentation of com.sun.star.form.validation.XValidator">validator</a>
for a form control, which can monitor a form text field.</td>
</tr>
@@ -2463,7 +2463,7 @@ for a form control, which can monitor a form text field.</td>
title="link to Forms/TimeValidator.java">TimeValidator</a></td>
<td class="cell80">The class <code>TimeValidator</code>
implements an <a
- href="../../docs/common/ref/com/sun/star/form/validation/XValidator.html"
+ href="../../docs/idl/ref/com_1_1sun_1_1star_1_1form_1_1validation_1_1XValidator.html"
title="link to the reference documentation of com.sun.star.form.validation.XValidator">validator</a>
for a form control, which can monitor the content of a form time field.
</td>
diff --git a/odk/examples/examples.html b/odk/examples/examples.html
index 16e7d9d..4ab7bc2 100644
--- a/odk/examples/examples.html
+++ b/odk/examples/examples.html
@@ -159,34 +159,34 @@
<tr>
<td class="cell20"><a href="java/Text/" title="link to the source directory of the Java Text examples">BookmarkInsertion</a></td>
<td class="cell80">This application connects to the office server and
- gets the <a href="../docs/common/ref/com/sun/star/lang/XMultiComponentFactory.html" title="link into the IDL reference to the interface com.sun.star.lang.XMultiComponentFactory"> multi component factory</a>. An empty text document will be opened
+ gets the <a href="../docs/idl/ref/com_1_1sun_1_1star_1_1lang_1_1XMultiComponentFactory.html" title="link into the IDL reference to the interface com.sun.star.lang.XMultiComponentFactory"> multi component factory</a>. An empty text document will be opened
and an example text will be entered. Afterwards, some bookmarks will be
inserted.</td>
</tr>
<tr>
<td class="cell20"><a href="java/Text/" title="link to the source directory of the Java Text examples">HardFormatting</a></td>
<td class="cell80">This program connects to the office server and gets
- the <a href="../docs/common/ref/com/sun/star/lang/XMultiComponentFactory.html" title="link into the IDL reference to the interface com.sun.star.lang.XMultiComponentFactory"> multi component factory</a>. Furthermore, an empty text document will be
+ the <a href="../docs/idl/ref/com_1_1sun_1_1star_1_1lang_1_1XMultiComponentFactory.html" title="link into the IDL reference to the interface com.sun.star.lang.XMultiComponentFactory"> multi component factory</a>. Furthermore, an empty text document will be
opened, an example text will be entered, some text attributes will be
- inspected, and the <a href="../docs/common/ref/com/sun/star/beans/PropertyState.html" title="link into the IDL reference to the enum com.sun.star.beans.PropertyState"> PropertyState</a> will be checked from the selection.</td>
+ inspected, and the <a href="../docs/idl/ref/com_1_1sun_1_1star_1_1beans_1_1PropertyState.html" title="link into the IDL reference to the enum com.sun.star.beans.PropertyState"> PropertyState</a> will be checked from the selection.</td>
</tr>
<tr>
<td class="cell20"><a href="java/Text/" title="link to the source directory of the Java Text examples">SWriter</a></td>
<td class="cell80">The program connects to the office server and gets the
- <a href="../docs/common/ref/com/sun/star/lang/XMultiComponentFactory.html" title="link into the IDL reference to the interface com.sun.star.lang.XMultiComponentFactory"> multi component factory</a>. An empty text document will be created, some
+ <a href="../docs/idl/ref/com_1_1sun_1_1star_1_1lang_1_1XMultiComponentFactory.html" title="link into the IDL reference to the interface com.sun.star.lang.XMultiComponentFactory"> multi component factory</a>. An empty text document will be created, some
text will be entered, and a text table, a colored text, and text frame
will be inserted.</td>
</tr>
<tr>
<td class="cell20"><a href="java/Text/" title="link to the source directory of the Java Text examples">StyleCreation</a></td>
<td class="cell80">The example connects to the office server and gets the
- <a href="../docs/common/ref/com/sun/star/lang/XMultiComponentFactory.html" title="link into the IDL reference to the interface com.sun.star.lang.XMultiComponentFactory"> multi component factory</a>. An empty text document will be opened, a new
+ <a href="../docs/idl/ref/com_1_1sun_1_1star_1_1lang_1_1XMultiComponentFactory.html" title="link into the IDL reference to the interface com.sun.star.lang.XMultiComponentFactory"> multi component factory</a>. An empty text document will be opened, a new
paragraph style will be created, and applied.</td>
</tr>
<tr>
<td class="cell20"><a href="java/Text/" title="link to the source directory of the Java Text examples">StyleInitialization</a></td>
<td class="cell80">The program connects to the office server and gets the
- <a href="../docs/common/ref/com/sun/star/lang/XMultiComponentFactory.html" title="link into the IDL reference to the interface com.sun.star.lang.XMultiComponentFactory"> multi component factory</a>. Thereafter, an empty text document will be
+ <a href="../docs/idl/ref/com_1_1sun_1_1star_1_1lang_1_1XMultiComponentFactory.html" title="link into the IDL reference to the interface com.sun.star.lang.XMultiComponentFactory"> multi component factory</a>. Thereafter, an empty text document will be
opened and an example text will be entered. The paragraph collection will
be used, in order to apply a different paragraph style on the
paragraphs.</td>
@@ -194,14 +194,14 @@
<tr>
<td class="cell20"><a href="java/Text/" title="link to the source directory of the Java Text examples">TextDocumentStructure</a></td>
<td class="cell80">The application connects to the office server and gets
- the <a href="../docs/common/ref/com/sun/star/lang/XMultiComponentFactory.html" title="link into the IDL reference to the interface com.sun.star.lang.XMultiComponentFactory"> multi component factory</a>. An empty text document will be opened, an
+ the <a href="../docs/idl/ref/com_1_1sun_1_1star_1_1lang_1_1XMultiComponentFactory.html" title="link into the IDL reference to the interface com.sun.star.lang.XMultiComponentFactory"> multi component factory</a>. An empty text document will be opened, an
enumeration of all paragraphs and an enumeration of all text portions
will be created.</td>
</tr>
<tr>
<td class="cell20"><a href="java/Text/" title="link to the source directory of the Java Text examples">TextReplace</a></td>
<td class="cell80">The example connects to the office server and gets the
- <a href="../docs/common/ref/com/sun/star/lang/XMultiComponentFactory.html" title="link into the IDL reference to the interface com.sun.star.lang.XMultiComponentFactory"> multi component factory</a>. An empty text document will be created, an
+ <a href="../docs/idl/ref/com_1_1sun_1_1star_1_1lang_1_1XMultiComponentFactory.html" title="link into the IDL reference to the interface com.sun.star.lang.XMultiComponentFactory"> multi component factory</a>. An empty text document will be created, an
example text will be inserted, and some English spelled words will be
replaced with US spelled words.</td>
</tr>
@@ -243,14 +243,14 @@
<tr>
<td class="cell20"><a href="java/Spreadsheet/" title="link to the source directory of the Java Spreadsheet examples">EuroAdaption</a></td>
<td class="cell80">The application connects to the office server and gets
- the <a href="../docs/common/ref/com/sun/star/lang/XMultiComponentFactory.html" title="link into the IDL reference to the interface com.sun.star.lang.XMultiComponentFactory"> multi component factory</a>, opens an empty Calc document, enters an
+ the <a href="../docs/idl/ref/com_1_1sun_1_1star_1_1lang_1_1XMultiComponentFactory.html" title="link into the IDL reference to the interface com.sun.star.lang.XMultiComponentFactory"> multi component factory</a>, opens an empty Calc document, enters an
example text, sets the number format to DM, changes the number format to
EUR (Euro), and uses the DM/EUR factor on each cell with content.</td>
</tr>
<tr>
<td class="cell20"><a href="java/Spreadsheet/" title="link to the source directory of the Java Spreadsheet examples">SCalc</a></td>
<td class="cell80">The program connects to the office server and gets the
- <a href="../docs/common/ref/com/sun/star/lang/XMultiComponentFactory.html" title="link into the IDL reference to the interface com.sun.star.lang.XMultiComponentFactory"> multi component factory</a>. Then an empty calc document will be opened,
+ <a href="../docs/idl/ref/com_1_1sun_1_1star_1_1lang_1_1XMultiComponentFactory.html" title="link into the IDL reference to the interface com.sun.star.lang.XMultiComponentFactory"> multi component factory</a>. Then an empty calc document will be opened,
cell styles will be created, some data will be inserted into the sheets,
and the created cell styles will be applied. Finally, a 3D chart will be
inserted.</td>
@@ -270,7 +270,7 @@
<tr>
<td class="cell20"><a href="java/Drawing/" title="link to the source directory of the Java Drawing examples">SDraw</a></td>
<td class="cell80">This program connects to the office server and gets
- the <a href="../docs/common/ref/com/sun/star/lang/XMultiComponentFactory.html" title="link into the IDL reference to the interface com.sun.star.lang.XMultiComponentFactory"> multi component factory</a>. Afterwards, an empty text document will
+ the <a href="../docs/idl/ref/com_1_1sun_1_1star_1_1lang_1_1XMultiComponentFactory.html" title="link into the IDL reference to the interface com.sun.star.lang.XMultiComponentFactory"> multi component factory</a>. Afterwards, an empty text document will
be created and some shapes will be inserted on the draw page.</td>
</tr>
<tbody>
@@ -492,7 +492,7 @@
<td class="cell80">The 'uno' program is used to export an arbitrary
service to other processes. In this example the com.sun.star.uno.Pipe
service (which is built in io-module) is exported. The client component
- implements the <a href="../docs/common/ref/com/sun/star/lang/XMain.html" title="link into the IDL reference to the interface com.sun.star.lang.XMain">
+ implements the <a href="../docs/idl/ref/com_1_1sun_1_1star_1_1lang_1_1XMain.html" title="link into the IDL reference to the interface com.sun.star.lang.XMain">
com.sun.star.lang.XMain</a> interface. In the run method, it connects to
the servers process and retrieves an instance and does some calls on the
instance.</td>
diff --git a/odk/examples/java/Spreadsheet/CalcAddins.java b/odk/examples/java/Spreadsheet/CalcAddins.java
index d658a4f..19eb524 100644
--- a/odk/examples/java/Spreadsheet/CalcAddins.java
+++ b/odk/examples/java/Spreadsheet/CalcAddins.java
@@ -36,7 +36,7 @@
/** You can find more
* information on the following web page:
- * http://api.libreoffice.org/docs/common/ref/com/sun/star/module-ix.html
+ * http://api.libreoffice.org/
*/
import com.sun.star.comp.loader.FactoryHelper;
import com.sun.star.lang.XMultiServiceFactory;
diff --git a/odk/index.html b/odk/index.html
index 7dd4b96..73deaa6 100644
--- a/odk/index.html
+++ b/odk/index.html
@@ -71,7 +71,7 @@
will be no limit for office automation in heterogeneous environments.
Currently supported platforms of the SDK are Linux, Solaris (sparc,
x86), and Windows.</p>
- <p>The SDK also contains <a href="docs/common/ref/com/sun/star/module-ix.html" title="link to the IDL reference documentation"> reference</a> documentation
+ <p>The SDK also contains <a href="docs/idl/ref/index.html" title="link to the IDL reference documentation"> reference</a> documentation
for the API and a complete <a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/OpenOffice.org_Developers_Guide" title="link to the Developer's Guide in the Wiki">Developer's Guide</a> is available online in the Apache OpenOffice Wiki, with
lots of examples, which introduce the API, explain the concepts behind
it, and make it possible for all users to quickly get started with
@@ -114,7 +114,7 @@
</tr>
<tr valign="top">
<td class="content4"><img src="docs/images/arrow-1.gif"></td>
- <td colspan="2"><a href="docs/common/ref/com/sun/star/module-ix.html" title="link to the IDL reference documentation">IDL Reference</a></td>
+ <td colspan="2"><a href="docs/idl/ref/index.html" title="link to the IDL reference documentation">IDL Reference</a></td>
<td class="content70">Complete LibreOffice %PRODUCT_RELEASE% API reference.</td>
</tr>
<tr valign="top">
diff --git a/odk/index_online.html b/odk/index_online.html
index f3ca65c..042c8b8 100644
--- a/odk/index_online.html
+++ b/odk/index_online.html
@@ -36,7 +36,7 @@
</tr>
<tr valign="top">
<td class="content4"><img src="docs/images/arrow-1.gif"></td>
- <td colspan="2"><a href="docs/common/ref/com/sun/star/module-ix.html" title="link to the IDL reference documentation">IDL Reference</a></td>
+ <td colspan="2"><a href="docs/idl/ref/index.html" title="link to the IDL reference documentation">IDL Reference</a></td>
<td class="content70">Complete LibreOffice API reference.</td>
</tr>
<tr valign="top">
commit d20d5acdd11cffa5f0e22af9601ce5a9878127a3
Author: Michael Stahl <mstahl at redhat.com>
Date: Fri May 3 23:43:45 2013 +0200
gbuild: UnoApi: revert documentation Package support
This was a good idea in its time and age (2 weeks ago) but has been
obsoleted by recent developments: sadly with the zoo of files
generated by doxygen this kind of tracking makes no sense.
Change-Id: I243de5cf6129ea3532067a39006d8e4259f15a95
diff --git a/solenv/gbuild/UnoApi.mk b/solenv/gbuild/UnoApi.mk
index 4807c32..00abff8 100644
--- a/solenv/gbuild/UnoApi.mk
+++ b/solenv/gbuild/UnoApi.mk
@@ -7,11 +7,6 @@
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
#
-gb_UnoApi_DOCDIR := $(gb_Package_SDKDIRNAME)/docs/common/ref
-# NOTE: this is the output dir used in odk/CustomTarget_autodoc.mk
-gb_UnoApi_SRCDOCDIR := $(call gb_CustomTarget_get_workdir,odk/docs/common/ref)
-gb_UnoApi_ENABLE_DOC := $(filter ODK,$(BUILD_TYPE))
-
# NOTE: This is needed temporarily to force rebuild with API files from
# $(WORKDIR), thus fixing generated deps. Otherwise, a change of an .idl
# file would not rebuild a .cxx if it still depended on the $(OUTDIR)
@@ -31,11 +26,6 @@ $(call gb_UnoApiTarget_UnoApiTarget,$(1))
$(call gb_UnoApiHeadersTarget_UnoApiHeadersTarget,$(1))
$(call gb_Package_Package_internal,$(1)_idl,$(SRCDIR))
$(call gb_Package_set_outdir,$(1)_idl,$(INSTDIR))
-$(call gb_Package_Package_internal,$(1)_inc,$(call gb_UnoApiHeadersTarget_get_dir,$(1)))
-ifneq ($(gb_UnoApi_ENABLE_DOC),)
-$(call gb_Package_Package_internal,$(1)_doc,$(gb_UnoApi_SRCDOCDIR))
-$(call gb_Package_set_outdir,$(1)_doc,$(INSTDIR))
-endif
$(call gb_UnoApiTarget_set_root,$(1),UCR)
@@ -82,51 +72,6 @@ $(call gb_UnoApi__add_headerfile_impl,$(1),$(2),$(subst $() $(),/,$(wordlist 2,$
endef
-ifneq ($(gb_UnoApi_ENABLE_DOC),)
-
-# gb_UnoApi__add_docfile_impl api htmlfile
-define gb_UnoApi__add_docfile_impl
-$(if $(filter-out com ooo org,$(firstword $(subst /, ,$(2)))),\
- $(call gb_Output_error,gb_UnoApi__add_docfile_impl: unknown namespace: $(firstword $(subst /, ,$(2)))) \
-)
-$(call gb_Package_add_file,$(1)_doc,$(gb_UnoApi_DOCDIR)/$(2),$(2))
-
-endef
-
-# gb_UnoApi__add_docfile_direct api htmlfile
-define gb_UnoApi__add_docfile_direct
-$(call gb_UnoApi__add_docfile_impl,$(1),$(patsubst $(1)/%,%,$(2)))
-
-endef
-
-# gb_UnoApi__add_docfile_for_idl api idlfile has-xref?
-define gb_UnoApi__add_docfile_for_idl
-$(if $(filter-out modules %-modules,$(basename $(notdir $(2)))),\
- $(call gb_UnoApi__add_docfile_direct,$(1),$(2).html) \
- $(if $(3),$(call gb_UnoApi__add_docfile_direct,$(1),$(2)-xref.html)) \
-)
-
-endef
-
-# gb_UnoApi__add_docfile api idlfile has-xref?
-define gb_UnoApi__add_docfile
-$(call gb_UnoApi__add_docfile_for_idl,$(1),$(2),$(3))
-
-endef
-
-# gb_UnoApi__add_docfiles api dir idlfiles has-xref?
-define gb_UnoApi__add_docfiles
-$(foreach idlfile,$(3),$(call gb_UnoApi__add_docfile_for_idl,$(1),$(2)/$(idlfile),$(3)))
-
-endef
-
-else
-
-gb_UnoApi__add_docfile :=
-gb_UnoApi__add_docfiles :=
-
-endif
-
define gb_UnoApi__add_idlfile_noheader
$(call gb_UnoApi__add_idlfile,$(1),$(2).idl)
@@ -148,14 +93,12 @@ endef
define gb_UnoApi_add_idlfile
$(call gb_UnoApiTarget_add_idlfile,$(1),$(2),$(3))
$(call gb_UnoApi__add_idlfile_full,$(1),$(2)/$(3))
-$(call gb_UnoApi__add_docfile,$(1),$(2)/$(3),$(true))
endef
define gb_UnoApi_add_idlfiles
$(call gb_UnoApiTarget_add_idlfiles,$(1),$(2),$(3))
$(foreach idl,$(3),$(call gb_UnoApi__add_idlfile_full,$(1),$(2)/$(idl)))
-$(call gb_UnoApi__add_docfiles,$(1),$(2),$(3),$(true))
endef
@@ -163,14 +106,12 @@ endef
define gb_UnoApi_add_idlfile_nohdl
$(call gb_UnoApiTarget_add_idlfile,$(1),$(2),$(3))
$(call gb_UnoApi__add_idlfile_nohdl,$(1),$(2)/$(3))
-$(call gb_UnoApi__add_docfile,$(1),$(2)/$(3))
endef
define gb_UnoApi_add_idlfiles_nohdl
$(call gb_UnoApiTarget_add_idlfiles,$(1),$(2),$(3))
$(foreach idl,$(3),$(call gb_UnoApi__add_idlfile_nohdl,$(1),$(2)/$(idl)))
-$(call gb_UnoApi__add_docfiles,$(1),$(2),$(3))
endef
@@ -178,14 +119,12 @@ endef
define gb_UnoApi_add_idlfile_noheader
$(call gb_UnoApiTarget_add_idlfile,$(1),$(2),$(3))
$(call gb_UnoApi__add_idlfile_noheader,$(1),$(2)/$(3))
-$(call gb_UnoApi__add_docfile,$(1),$(2)/$(3))
endef
define gb_UnoApi_add_idlfiles_noheader
$(call gb_UnoApiTarget_add_idlfiles,$(1),$(2),$(3))
$(foreach idl,$(3),$(call gb_UnoApi__add_idlfile_noheader,$(1),$(2)/$(idl)))
-$(call gb_UnoApi__add_docfiles,$(1),$(2),$(3))
endef
commit 8d3060ea92dd3643ef543fb67a6d012e77ac814a
Author: Michael Stahl <mstahl at redhat.com>
Date: Fri May 3 23:19:14 2013 +0200
API CHANGE: odk: stop packaging autodoc tool
There is no need to package doxygen, users can just download that from
upstream.
Change-Id: I166b2f5b692d2335246e3484089ebe5d8edcae4a
diff --git a/odk/Package_bin.mk b/odk/Package_bin.mk
index 8c1200f..46d447a 100644
--- a/odk/Package_bin.mk
+++ b/odk/Package_bin.mk
@@ -13,7 +13,6 @@ $(eval $(call gb_Package_set_outdir,odk_bin,$(INSTDIR)))
$(eval $(call gb_Package_add_files,odk_bin,$(gb_Package_SDKDIRNAME)/bin,\
$(addsuffix $(gb_Executable_EXT),\
- autodoc \
$(if $(filter WNT,$(OS)),climaker) \
cppumaker \
idlc \
diff --git a/odk/Package_docs.mk b/odk/Package_docs.mk
index 24052a9..515c682 100644
--- a/odk/Package_docs.mk
+++ b/odk/Package_docs.mk
@@ -12,7 +12,6 @@ $(eval $(call gb_Package_Package,odk_docs,$(SRCDIR)/odk))
$(eval $(call gb_Package_set_outdir,odk_docs,$(INSTDIR)))
$(eval $(call gb_Package_add_files_with_dir,odk_docs,$(gb_Package_SDKDIRNAME),\
- docs/common/ref/idl.css \
docs/images/arrow-1.gif \
docs/images/arrow-2.gif \
docs/images/arrow-3.gif \
diff --git a/odk/docs/common/ref/idl.css b/odk/docs/common/ref/idl.css
deleted file mode 100644
index b9c89a2..0000000
--- a/odk/docs/common/ref/idl.css
+++ /dev/null
@@ -1,151 +0,0 @@
-/* Autodoc css file for IDL documentation */
-/*
- * This file is part of the LibreOffice project.
- *
- * This Source Code Form is subject to the terms of the Mozilla Public
- * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at http://mozilla.org/MPL/2.0/.
- *
- * This file incorporates work covered by the following license notice:
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed
- * with this work for additional information regarding copyright
- * ownership. The ASF licenses this file to you under the Apache
- * License, Version 2.0 (the "License"); you may not use this file
- * except in compliance with the License. You may obtain a copy of
- * the License at http://www.apache.org/licenses/LICENSE-2.0 .
- */
-
-/*See bottom of file for explanations.*/
-
-body { background-color:#ffffff; }
-
-#adc-idlref a { color: #000000; text-decoration: none; }
-#adc-idlref a:link { color: #18A303; text-decoration: none; }
-#adc-idlref a:hover { text-decoration: underline; }
-#adc-idlref a:visited { color: #106802; }
-
-#adc-idlref h3
- { font-size:13pt; font-weight:bold;
- margin-top:3pt; margin-bottom:1pt; }
-
-#adc-idlref p, #adc-idlref dt, #adc-idlref dd, #adc-idlref pre
- { font-size:11pt;
- margin-top:3pt; margin-bottom:1pt; }
-
-#adc-idlref pre { font-family:monospace; }
-
-#adc-idlref table.subtitle { margin-top:6pt; margin-bottom:6pt; }
-
-#adc-idlref td { font-size:11pt; }
-#adc-idlref td.title
- { font-family: Arial; font-size:19pt; font-weight:bold;
- line-height:30pt;
- background-color:#18a303;
- text-align:center; }
-
-#adc-idlref td.subtitle
- { font-family: Arial; font-size:13pt;
- line-height:20pt;
- background-color:#18a303; }
-
-#adc-idlref td.crosstitle
- { font-size:12pt; font-weight:bold;
- line-height:15pt; background-color:#eeeeff; }
-
-#adc-idlref td.imdetail
- { width:100%;
- background-color:#c2f6ba; }
-
-#adc-idlref td.imsum_left { width:30%; }
-#adc-idlref td.imsum_right { width:70%; }
-
-#adc-idlref table.navimain { background-color:#18a303; }
-
-#adc-idlref td.navimain
- { background-color:#18a303;
- text-align:center;
- font-family: Arial; font-size:12pt; font-weight:bold;
- padding-left:7pt; padding-right:7pt; }
-
-#adc-idlref td.navimainself
- { text-align:center;
- font-family: Arial; font-size:12pt; font-weight:bold;
- color:#ffffff; background-color:#106802;}
-
-#adc-idlref td.navimainnone
- { text-align:center;
- font-family: Arial; font-size:12pt;
- color:#ffffff; }
-
-#adc-idlref td.navisub
- { text-align:center;
- font-family: Arial; font-size:9pt; font-variant:small-caps;
- padding-left:7pt; padding-right:7pt; }
-
-#adc-idlref a.navimain
- { text-align:center;
- font-family: Arial; font-size:12pt; font-weight:bold;
- color:#C44B01; }
-
-#adc-idlref a.navisub
- { text-align:center;
- font-family: Arial; font-size:9pt; font-variant:small-caps;
- color:#C44B01; }
-
-#adc-idlref a.membertitle { font-size:12pt; font-weight:bold; line-height:18pt; }
-
-#adc-idlref a:link.navisub { color:#18a303; }
-#adc-idlref a:visited.navisub { color: #106802; }
-#adc-idlref a:hover.navisub { color: #106802; text-decoration: underline; }
-
-#adc-idlref a:link.navimain { color:#ffffff; }
-#adc-idlref a:visited.navimain { color: #ffffff; }
-#adc-idlref a:hover.navimain { color: #ffffff; text-decoration: underline; }
-
-#adc-idlref .dt { font-weight:bold; }
-#adc-idlref .namechain { font-size:13pt; font-weight:bold; margin-top:3pt; margin-bottom:6pt; }
-#adc-idlref .title2 { font-size:13pt; font-style:italic; font-weight:bold; text-align:left; }
-
-#adc-idlref table { empty-cells:show; }
-
-#adc-idlref .childlist td,
-#adc-idlref .commentedlinks td,
-#adc-idlref .memberlist td,
-#adc-idlref .subtitle td,
-#adc-idlref .crosstitle td { border: .1pt solid grey; }
-
-#adc-idlref .flag-table td { border: .1pt solid #cccccc; }
-
-#adc-idlref .title-table td,
-#adc-idlref .table-in-method td,
-#adc-idlref .table-in-data td,
-#adc-idlref .navimain td,
-#adc-idlref .navisub td,
-#adc-idlref .expl-table td,
-#adc-idlref .param-table td { border: none; }
-
-
-/* Explanation of CSS classes:
-
-table.lightbg Background of navigation bar.
-.navimain Text in main navigation bar.
-.navisub Text in lower navigation bar.
-td.navimainself Cell in main navigation bar with "selected" shadow: You are here.
-td.navimainnone Cell in main navigation bar with no link.
-
-.namechain Line with current module path.
-
-td.crosstitle Comment box for bases (base interfaces etc.)
-td.imsum_left Left part of such boxes.
-td.imsum_right Right part of such boxes.
-
-td.title Main title of the page like "interface XYz"
-.subtitle Tables, and head cells of those, which list members
- like "method summary" and "method details".
-
-td.imdetail Background table of method's detail description.
-a.membertitle Method name (as jump label) in method's detail
- description.
-*/
diff --git a/odk/docs/tools.html b/odk/docs/tools.html
index 219e594..364cb09 100644
--- a/odk/docs/tools.html
+++ b/odk/docs/tools.html
@@ -128,12 +128,6 @@
in a human readable manner. Special support for type library
nodes.</td>
</tr>
- <tr valign="top">
- <td class="content3"><img src="images/arrow-1.gif"></td>
- <td><a href="#autodoc" title="link to the autodoc tool description">autodoc</a></td>
- <td class="content87">Tool to generate javadoc-like documentation
- for C/C++ and UNOIDL files.</td>
- </tr>
</table>
</td>
</tr>
@@ -923,94 +917,13 @@ types the specified types depend on.</p>
</tr>
<tr>
<td colspan="3">
- <p>The 'autodoc' tool is used for creating javadoc-like documentation
- from C++ and UNOIDL source code.</p>
- <p>There are some conventions to follow when documenting C++- or
- UNOIDL-sourcecode. See also the <a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/AppendixB/IDL_Documentation_Guidelines" title="link to the UNOIDL Documentation Guidelines">UNOIDL Documentation Guidelines</a>.<br>
- If you are not familiar with these, but do know javadoc: For simple C++
- sourcecode documentation, using javadoc-style comments will work.</p>
- <p class="head2">Usage:</p>
- <blockquote>
- <b><code>autodoc [ -v <VerboseNr> ] [ -name "<TitleForTheDocu>" ] -html <OutputDirectory> -lg <SourcecodeLanguage><br>
- { [ -p <ProjectName> <ProjectRootDirectory> ] -t <SourceTree>* | -d <SourceDirectory>* | -f <SourceFile>* }*</code></b>
- </blockquote>
- <p class="head2">Options:</p>
- <p>
- <table width="100%" border="1" cellpadding="4" cellspacing="0">
- <tr>
- <td class="cell15"><code>-v <VerboseNr></code></td>
- <td class="cell85"><VerboseNr> == 5 displays the parsed source
- code tokens, so you can locate which piece caused an parsing error.<br>
- <VerboseNr> == 2 displays not only the parsed source code,
- but also the comments.<br><br>
- This option must be the first one, if it is used.</td>
- </tr>
- <tr>
- <td class="cell15"><code>-name "<Title>"</code></td>
- <td class="cell85"><Title> occurs as the title of the start
- page of the HTML output. If this option is omitted, a default title is
- created.</td>
- </tr>
- <tr>
- <td class="cell15"><code>-html <OutputDirectory></code></td>
- <td class="cell85">specifies the root directory where the HTML output
- is created.<br>
- Autodoc does not remove old files there, though it overwrites them.</td>
- </tr>
- <tr>
- <td class="cell15"><code>-lg <SourcecodeLanguage></code></td>
- <td class="cell85">Possible values are: c++ | idl.<br><br>
- This also specifies which files will be parsed: "c++" parses
- all files with the endings .hxx and .h, "idl" parses all
- files with the ending '.idl' .<br>
- To change this behaviour, see at option <code>-f</code>.</td>
- </tr>
- <tr>
- <td class="cell15"><code>-p <ProjectName> <ProjectDirectory></code></td>
- <td class="cell85">this option can be used to divide large code
- bases into different projects.<br>
- <ProjectName> gives a user-defined name for the project.<br>
- <ProjectDirectory> is the root to which all paths, given with the
- following options <code>-t,-d</code> and <code>-f</code>, are
- relative.<br>
- This option can be omitted when there are no projects and all paths in
- the following options are relative to the working directory.<br><br>
- The "{ ... }*" around the options <code>-p,-t,-d,-f</code>
- indicates, that this whole block of options can be repeated, each block
- starting with a new <code>-p</code>.</td>
- </tr>
- <tr>
- <td class="cell15"><code>-t <SourceTree></code></td>
- <td class="cell85">specifies that all files in the directory
- <SourceTree> and it's subdirectories are parsed, where the file
- ending matches the option <code>-lg</code>.<br>
- There can be given multiple directories after one <code>-t</code>
- option.<br>
- All relative paths are relative to the project-rootdirectory,
- given with the <code>-p</code> option.<br>
- </td>
- </tr>
- <tr>
- <td class="cell15"><code>-d <SourceDirectory></code></td>
- <td class="cell85">Specifies that all files in th directory
- <SourceDirectory>, but NOT it's subdirectories, are parsed, where
- the file ending matches the option <code>-lg</code>.<br>
- There can be multiple directories given after one <code>-d</code>
- option.<br>
- All relative paths are relative to the project-rootdirectory,
- given with the <code>-p</code> option.</td>
- </tr>
- <tr>
- <td class="cell15"><code>-f <SourceFile></code></td>
- <td class="cell85">parses the given file. The ending does not have
- to match the <code>-lg</code> option.<br>
- There can be multiple files given after one <code>-f</code> option.<br>
- All relative paths are relative to the project-rootdirectory,
- given with the <code>-p</code> option.</td>
- </tr>
- </table>
- </p><b>Remark:</b> The sequence of options matters! Use them in the order given
- in the "Usage"-paragraph.</p>
+ <p>The legacy 'autodoc' tool was used for creating javadoc-like
+ documentation from C++ and UNO IDL source code in previous versions
+ of the SDK.</p>
+ <p>Because this tool was buggy and unmaintained it has been removed
+ from the SDK. Users are advised to use
+ <a href="http://www.stack.nl/~dimitri/doxygen/">Doxygen</a> instead,
+ which supports UNO IDL since April 2013.</p>
</td>
</tr>
</table>
diff --git a/odk/util/check.pl b/odk/util/check.pl
index 52cde54..f1a3a3f 100644
--- a/odk/util/check.pl
+++ b/odk/util/check.pl
@@ -47,7 +47,7 @@ if (-d "$PrimaryDir" || -d "$SecondaryDir") {
print "check binaries: ";
if (check_dir("bin")) {
my @binarylist = ( "idlc","cppumaker","javamaker",
- "regcompare","autodoc",
+ "regcompare",
"unoapploader", "uno-skeletonmaker" );
if ($ENV{SYSTEM_UCPP} eq "") {
push @binarylist,"ucpp";
@@ -97,7 +97,7 @@ if (-d "$PrimaryDir" || -d "$SecondaryDir") {
"images/nav_right.png","images/nav_up.png",
"images/sdk_head-1.png", "images/sdk_head-2.png",
"images/sdk_line-1.gif", "images/sdk_line-2.gif",
- "common/ref/idl.css", "images/nada.gif",
+ "images/nada.gif",
"images/arrow-2.gif", "images/bluball.gif",
"images/ooo-main-app_32.png");
commit 6e93e5911ce005b74c0807f29096a12f1b34b691
Author: Michael Stahl <mstahl at redhat.com>
Date: Fri May 3 23:01:03 2013 +0200
odk: stop packaging autodoc generated documentation
Change-Id: I9d1e232f2fea779f111067b588bbb36411039de2
diff --git a/odk/CustomTarget_autodoc.mk b/odk/CustomTarget_autodoc.mk
deleted file mode 100644
index 126d5e2..0000000
--- a/odk/CustomTarget_autodoc.mk
+++ /dev/null
@@ -1,34 +0,0 @@
-# -*- Mode: makefile-gmake; tab-width: 4; indent-tabs-mode: t -*-
-#
-# This file is part of the LibreOffice project.
-#
-# This Source Code Form is subject to the terms of the Mozilla Public
-# License, v. 2.0. If a copy of the MPL was not distributed with this
-# file, You can obtain one at http://mozilla.org/MPL/2.0/.
-#
-
-$(eval $(call gb_CustomTarget_CustomTarget,odk/docs/common/ref))
-
-$(eval $(call gb_CustomTarget_register_targets,odk/docs/common/ref,\
- autodoc_log.txt \
-))
-
-$(call gb_CustomTarget_get_workdir,odk/docs/common/ref)/%.html : $(call gb_CustomTarget_get_workdir,odk/docs/common/ref)/autodoc_log.txt
- touch $@
-
-$(call gb_CustomTarget_get_workdir,odk/docs/common/ref)/autodoc_log.txt : \
- $(SRCDIR)/odk/pack/copying/idl_chapter_refs.txt \
- $(SRCDIR)/odk/docs/common/ref/idl.css \
- $(call gb_Executable_get_runtime_dependencies,autodoc)
- $(call gb_Output_announce,$(subst $(WORKDIR)/,,$@),$(true),AUD,1)
- $(call gb_Executable_get_command,autodoc) \
- -html $(dir $@) \
- -dvgroot "http://wiki.services.openoffice.org/wiki" \
- -name "LibreOffice $(PRODUCTVERSION) API" \
- -lg idl \
- -dvgfile $< \
- -t $(SRCDIR)/udkapi $(SRCDIR)/offapi \
- > $@
-
-
-# vim: set noet sw=4 ts=4:
diff --git a/odk/CustomTarget_check.mk b/odk/CustomTarget_check.mk
index e081da0..2affc28 100644
--- a/odk/CustomTarget_check.mk
+++ b/odk/CustomTarget_check.mk
@@ -10,7 +10,6 @@
$(eval $(call gb_CustomTarget_CustomTarget,odk/check))
$(eval $(call gb_CustomTarget_register_targets,odk/check,\
- autodoc \
checkbin \
))
@@ -44,8 +43,7 @@ $(call gb_CustomTarget_get_workdir,odk/check)/checkbin : \
$(if $(filter MACOSX,$(OS)),$(call gb_Package_get_target,odk_macosx)) \
$(call gb_Package_get_target,odk_settings) \
$(call gb_Package_get_target,odk_settings_generated) \
- $(if $(SOLAR_JAVA),$(call gb_Package_get_target,odk_unowinreg)) \
- $(call gb_PackageSet_get_target,odk_autodoc)
+ $(if $(SOLAR_JAVA),$(call gb_Package_get_target,odk_unowinreg))
$(call gb_Output_announce,$(subst $(WORKDIR)/,,$@),$(true),CHK,1)
$(call gb_Helper_print_on_error,\
$(PERL) $< \
@@ -55,20 +53,4 @@ $(call gb_CustomTarget_get_workdir,odk/check)/checkbin : \
,$@.log \
)
-.PHONY : $(call gb_CustomTarget_get_workdir,odk/check)/autodoc
-$(call gb_CustomTarget_get_workdir,odk/check)/autodoc : $(call gb_PackageSet_get_target,odk_autodoc)
- $(call gb_Output_announce,$(subst $(WORKDIR)/,,$@),$(true),CHK,1)
- ( \
- c=0 && \
- for m in `find $(call gb_CustomTarget_get_workdir,odk/docs/common/ref) -name module-ix.html`; do \
- m=`echo $$m | sed -e s@$(call gb_CustomTarget_get_workdir,odk/docs/common/ref)/@@` && \
- mm=$(INSTDIR)/$(gb_Package_SDKDIRNAME)/docs/common/ref/$${m} && \
- if [ ! -e $${mm} ]; then \
- c=`expr $$c + 1`; \
- echo "autodoc check: $${mm} not found. Please update odk/Package_autodoc.mk ."; \
- fi \
- done && \
- if [ $${c} -gt 0 ]; then exit 1; fi \
- )
-
# vim: set noet sw=4 ts=4:
diff --git a/odk/Module_odk.mk b/odk/Module_odk.mk
index 8ebb35b..07d76bd 100644
--- a/odk/Module_odk.mk
+++ b/odk/Module_odk.mk
@@ -17,9 +17,7 @@ $(eval $(call gb_Module_add_targets,odk,\
) \
CustomTarget_html \
CustomTarget_settings \
- CustomTarget_autodoc \
Executable_unoapploader \
- Package_autodoc \
Package_bin \
Package_config \
Package_docs \
@@ -30,7 +28,6 @@ $(eval $(call gb_Module_add_targets,odk,\
Package_odk_headers_generated \
Package_settings \
Package_settings_generated \
- PackageSet_autodoc \
PackageSet_odk_headers \
))
diff --git a/odk/PackageSet_autodoc.mk b/odk/PackageSet_autodoc.mk
deleted file mode 100644
index 4e0ea6a..0000000
--- a/odk/PackageSet_autodoc.mk
+++ /dev/null
@@ -1,18 +0,0 @@
-# -*- Mode: makefile-gmake; tab-width: 4; indent-tabs-mode: t -*-
-#
-# This file is part of the LibreOffice project.
-#
-# This Source Code Form is subject to the terms of the Mozilla Public
-# License, v. 2.0. If a copy of the MPL was not distributed with this
-# file, You can obtain one at http://mozilla.org/MPL/2.0/.
-#
-
-$(eval $(call gb_PackageSet_PackageSet,odk_autodoc))
-
-$(eval $(call gb_PackageSet_add_packages,odk_autodoc,\
- odk_autodoc \
- offapi_doc \
- udkapi_doc \
-))
-
-# vim: set noet sw=4 ts=4:
diff --git a/odk/Package_autodoc.mk b/odk/Package_autodoc.mk
deleted file mode 100644
index bd1117b..0000000
--- a/odk/Package_autodoc.mk
+++ /dev/null
@@ -1,175 +0,0 @@
-# -*- Mode: makefile-gmake; tab-width: 4; indent-tabs-mode: t -*-
-#
-# This file is part of the LibreOffice project.
-#
-# This Source Code Form is subject to the terms of the Mozilla Public
-# License, v. 2.0. If a copy of the MPL was not distributed with this
-# file, You can obtain one at http://mozilla.org/MPL/2.0/.
-#
-
-$(eval $(call gb_Package_Package,odk_autodoc,$(call gb_CustomTarget_get_workdir,odk/docs/common/ref)))
-
-$(eval $(call gb_Package_set_outdir,odk_autodoc,$(INSTDIR)))
-
-# indices
-$(eval $(call gb_Package_add_files_with_dir,odk_autodoc,$(gb_Package_SDKDIRNAME)/docs/common/ref,\
- index-files/index-1.html \
- index-files/index-10.html \
- index-files/index-11.html \
- index-files/index-12.html \
- index-files/index-13.html \
- index-files/index-14.html \
- index-files/index-15.html \
- index-files/index-16.html \
- index-files/index-17.html \
- index-files/index-18.html \
- index-files/index-19.html \
- index-files/index-2.html \
- index-files/index-20.html \
- index-files/index-21.html \
- index-files/index-22.html \
- index-files/index-23.html \
- index-files/index-24.html \
- index-files/index-25.html \
- index-files/index-26.html \
- index-files/index-27.html \
- index-files/index-3.html \
- index-files/index-4.html \
- index-files/index-5.html \
- index-files/index-6.html \
- index-files/index-7.html \
- index-files/index-8.html \
- index-files/index-9.html \
-))
-
-# module lists
-$(eval $(call gb_Package_add_files_with_dir,odk_autodoc,$(gb_Package_SDKDIRNAME)/docs/common/ref,\
- module-ix.html \
- $(addsuffix /module-ix.html,\
- com \
- com/sun \
- com/sun/star \
- com/sun/star/accessibility \
- com/sun/star/animations \
- com/sun/star/auth \
- com/sun/star/awt \
- com/sun/star/awt/grid \
- com/sun/star/awt/tab \
- com/sun/star/awt/tree \
- com/sun/star/beans \
- com/sun/star/bridge \
- com/sun/star/bridge/oleautomation \
- com/sun/star/chart \
- com/sun/star/chart2 \
- com/sun/star/chart2/data \
- com/sun/star/configuration \
- com/sun/star/configuration/backend \
- com/sun/star/configuration/backend/xml \
- com/sun/star/configuration/bootstrap \
- com/sun/star/connection \
- com/sun/star/container \
- com/sun/star/cui \
- com/sun/star/datatransfer \
- com/sun/star/datatransfer/clipboard \
- com/sun/star/datatransfer/dnd \
- com/sun/star/deployment \
- com/sun/star/deployment/test \
- com/sun/star/deployment/ui \
- com/sun/star/document \
- com/sun/star/drawing \
- com/sun/star/drawing/framework \
- com/sun/star/embed \
- com/sun/star/form \
- com/sun/star/form/binding \
- com/sun/star/form/component \
- com/sun/star/form/control \
- com/sun/star/form/inspection \
- com/sun/star/form/runtime \
- com/sun/star/form/submission \
- com/sun/star/form/validation \
- com/sun/star/formula \
- com/sun/star/frame \
- com/sun/star/frame/status \
- com/sun/star/gallery \
- com/sun/star/geometry \
- com/sun/star/graphic \
- com/sun/star/i18n \
- com/sun/star/image \
- com/sun/star/inspection \
- com/sun/star/io \
- com/sun/star/java \
- com/sun/star/lang \
- com/sun/star/ldap \
- com/sun/star/linguistic2 \
- com/sun/star/loader \
- com/sun/star/logging \
- com/sun/star/mail \
- com/sun/star/media \
- com/sun/star/mozilla \
- com/sun/star/office \
- com/sun/star/packages \
- com/sun/star/packages/manifest \
- com/sun/star/packages/zip \
- com/sun/star/plugin \
- com/sun/star/presentation \
- com/sun/star/presentation/textfield \
- com/sun/star/qa \
- com/sun/star/rdf \
- com/sun/star/reflection \
- com/sun/star/registry \
- com/sun/star/rendering \
- com/sun/star/report \
- com/sun/star/report/inspection \
- com/sun/star/report/meta \
- com/sun/star/resource \
- com/sun/star/scanner \
- com/sun/star/script \
- com/sun/star/script/browse \
- com/sun/star/script/provider \
- com/sun/star/script/vba \
- com/sun/star/sdb \
- com/sun/star/sdb/application \
- com/sun/star/sdb/tools \
- com/sun/star/sdbc \
- com/sun/star/sdbcx \
- com/sun/star/security \
- com/sun/star/setup \
- com/sun/star/sheet \
- com/sun/star/smarttags \
- com/sun/star/style \
- com/sun/star/svg \
- com/sun/star/system \
- com/sun/star/table \
- com/sun/star/task \
- com/sun/star/text \
- com/sun/star/text/fieldmaster \
- com/sun/star/text/textfield \
- com/sun/star/text/textfield/docinfo \
- com/sun/star/ucb \
- com/sun/star/ui \
- com/sun/star/ui/dialogs \
- com/sun/star/uno \
- com/sun/star/uri \
- com/sun/star/util \
- com/sun/star/view \
- com/sun/star/xforms \
- com/sun/star/xml \
- com/sun/star/xml/crypto \
- com/sun/star/xml/crypto/sax \
- com/sun/star/xml/csax \
- com/sun/star/xml/dom \
- com/sun/star/xml/dom/events \
- com/sun/star/xml/dom/views \
- com/sun/star/xml/input \
- com/sun/star/xml/sax \
- com/sun/star/xml/wrapper \
- com/sun/star/xml/xpath \
- com/sun/star/xml/xslt \
- com/sun/star/xsd \
- org \
- org/freedesktop \
- org/freedesktop/PackageKit \
- ) \
-))
-
-# vim: set noet sw=4 ts=4:
diff --git a/odk/util/check.pl b/odk/util/check.pl
index 542361e..52cde54 100644
--- a/odk/util/check.pl
+++ b/odk/util/check.pl
@@ -223,17 +223,17 @@ if (-d "$PrimaryDir" || -d "$SecondaryDir") {
#check idl docu, it is only a first and simple check
# improvement required
print "check idl docu: ";
- if (check_dir("docs/common/ref")) {
- if (!check_file("docs/common/ref/module-ix.html")) {
- print "\nERROR: \"docs/common/ref/module-ix.html\" is missing\n";
+ if (check_dir("docs/idl/ref")) {
+ if (!check_file("docs/idl/ref/index.html")) {
+ print "\nERROR: \"docs/idl/ref/index.html\" is missing\n";
$return++;
}
- if (!check_dir("docs/common/ref/index-files")) {
- print "\nERROR: \"docs/common/ref/index-files\" is missing\n";
+ if (!check_file("docs/idl/ref/classes.html")) {
+ print "\nERROR: \"docs/idl/ref/classes.html\" is missing\n";
$return++;
}
- if (!check_file("docs/common/ref/index-files/index-10.html")) {
- print "\nERROR: \"docs/common/ref/index-files/index-10.html\" is missing\n";
+ if (!check_file("docs/idl/ref/namespaces.html")) {
+ print "\nERROR: \"docs/idl/ref/namespaces.html\" is missing\n";
$return++;
}
@@ -348,9 +348,10 @@ if (-d "$PrimaryDir" || -d "$SecondaryDir") {
foreach $i (@idl_dirlist)
{
- if (!check_dir("docs/common/ref/com/sun/star/$i")) {
+ $i =~ s/\//_1_1/g;
+ if (!check_file("docs/idl/ref/com_1_1sun_1_1star_1_1$i.html")) {
$return++;
- print "\nERROR: \"docs/common/ref/com/sun/star/$i\" is missing\n";
+ print "\nERROR: \"docs/idl/ref/com_1_1sun_1_1star_1_1$i.html\" is missing\n";
} else {
print "+";
}
diff --git a/scp2/source/sdkoo/module_sdkoo.scp b/scp2/source/sdkoo/module_sdkoo.scp
index d0f57fa..ce6795d 100644
--- a/scp2/source/sdkoo/module_sdkoo.scp
+++ b/scp2/source/sdkoo/module_sdkoo.scp
@@ -34,7 +34,6 @@ Module gid_Module_Optional_Sdkoo
ParentID = gid_Module_Optional;
Default = NO;
Files = (
- gid_File_Package_odk_autodoc,
gid_File_Package_odk_bin,
gid_File_Package_odk_cli,
gid_File_Package_odk_config,
diff --git a/scp2/source/sdkoo/sdkoo.scp b/scp2/source/sdkoo/sdkoo.scp
index 87b3192..2dde1fb 100644
--- a/scp2/source/sdkoo/sdkoo.scp
+++ b/scp2/source/sdkoo/sdkoo.scp
@@ -116,13 +116,6 @@ File gid_File_Txt_Readme
Styles = (PACKED, SCPZIP_REPLACE);
End
-File gid_File_Package_odk_autodoc
- TXT_FILE_BODY;
- Dir = FILELIST_SDK_DIR;
- Name = "odk_autodoc.filelist";
- Styles = (FILELIST,USE_INTERNAL_RIGHTS);
-End
-
File gid_File_Package_odk_bin
TXT_FILE_BODY;
Dir = FILELIST_SDK_DIR;
commit fa9cbdb4a985cc1de3bab5ff1b05ff56ab983ec5
Author: Michael Stahl <mstahl at redhat.com>
Date: Fri May 3 21:40:26 2013 +0200
odk: package doxygen IDL docs
Change-Id: I1613ce8cf9b8248bb5d5e546df7310154e11b830
diff --git a/odk/Module_odk.mk b/odk/Module_odk.mk
index 94f8fc1..8ebb35b 100644
--- a/odk/Module_odk.mk
+++ b/odk/Module_odk.mk
@@ -13,7 +13,7 @@ $(eval $(call gb_Module_add_targets,odk,\
$(if $(filter WNT,$(OS)),Package_cli) \
$(if $(DOXYGEN),\
CustomTarget_doxygen \
- Zip_cppdocs \
+ Zip_doxygen \
) \
CustomTarget_html \
CustomTarget_settings \
diff --git a/odk/Zip_cppdocs.mk b/odk/Zip_doxygen.mk
similarity index 67%
rename from odk/Zip_cppdocs.mk
rename to odk/Zip_doxygen.mk
index 10e3249..dbc6616 100644
--- a/odk/Zip_cppdocs.mk
+++ b/odk/Zip_doxygen.mk
@@ -7,15 +7,16 @@
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
#
-$(eval $(call gb_Zip_Zip,cppdocs,$(call gb_CustomTarget_get_workdir,odk/odkcommon)))
+$(eval $(call gb_Zip_Zip,doxygen,$(call gb_CustomTarget_get_workdir,odk/odkcommon)))
-$(eval $(call gb_Zip_add_files,cppdocs,\
+$(eval $(call gb_Zip_add_files,doxygen,\
docs/cpp/ref \
+ docs/idl/ref \
))
-$(eval $(call gb_Zip_add_commandoptions,cppdocs,-r))
+$(eval $(call gb_Zip_add_commandoptions,doxygen,-r))
-$(call gb_Zip_get_target,cppdocs) : \
+$(call gb_Zip_get_target,doxygen) : \
$(call gb_CustomTarget_get_target,odk/odkcommon/docs)
# vim: set noet sw=4 ts=4:
diff --git a/scp2/source/sdkoo/module_sdkoo.scp b/scp2/source/sdkoo/module_sdkoo.scp
index b59f8cd..d0f57fa 100644
--- a/scp2/source/sdkoo/module_sdkoo.scp
+++ b/scp2/source/sdkoo/module_sdkoo.scp
@@ -48,7 +48,7 @@ Module gid_Module_Optional_Sdkoo
gid_File_Package_odk_settings,
gid_File_Package_odk_settings_generated,
gid_File_Package_odk_unowinreg,
- gid_File_Zip_cppdocs,
+ gid_File_Zip_doxygen,
gid_File_Zip_Odkexamples,
gid_File_Zip_OdkIdl_udkapi,
gid_File_Zip_OdkIdl_offapi,
diff --git a/scp2/source/sdkoo/sdkoo.scp b/scp2/source/sdkoo/sdkoo.scp
index a9388af..87b3192 100644
--- a/scp2/source/sdkoo/sdkoo.scp
+++ b/scp2/source/sdkoo/sdkoo.scp
@@ -225,10 +225,10 @@ End
#endif
#if defined(DOXYGEN)
-File gid_File_Zip_cppdocs
+File gid_File_Zip_doxygen
TXT_FILE_BODY;
Dir = gid_Dir_Basis_Sdk;
- Name = "cppdocs.zip";
+ Name = "doxygen.zip";
Styles = (ARCHIVE,USE_INTERNAL_RIGHTS);
End
#endif
commit 426c74bf6b92f1e066405ce54c4259c14bc45db8
Author: Michael Stahl <mstahl at redhat.com>
Date: Fri May 3 00:27:05 2013 +0200
offapi: fix another mangled comment
Change-Id: I76b531238d86c9f2ed444d230638ffb9a2d62618
diff --git a/offapi/com/sun/star/util/PathSubstitution.idl b/offapi/com/sun/star/util/PathSubstitution.idl
index 7a09375..14d1ce9 100644
--- a/offapi/com/sun/star/util/PathSubstitution.idl
+++ b/offapi/com/sun/star/util/PathSubstitution.idl
@@ -30,7 +30,7 @@ module com { module sun { module star { module util {
/** A service to support the substitution and resubstitution of path variables.
- <p>
+ <p>
A path variable must be specified with the following syntax: "$("<variable-name>")".
Path variables are not case sensitive and are always provided as a UCB-compliant URLs
(for example: "file:///c:/temp" or "file:///usr/install"). This is mandatory to support an
@@ -39,40 +39,40 @@ module com { module sun { module star { module util {
configuration file (org/openoffice/Office/Substitution.xml). Please have a look at the
schema definition file which configuration structure this file uses.<br>
There is also a set of variables that have pre-defined values:
- </p>
- <dl>
- <dt>$(inst)</dt>
- <dd>Installation path of the Office.</dd>
- <dt>$(prog)</dt>
- <dd>Program path of the Office.</dd>
- <dt>$(user)</dt>
- <dd>The user installation directory.</dd>
- <dt>$(work)</dt>
- <dd>The work directory of the user. Under Windows this would be the
+ </p>
+ <dl>
+ <dt>\$(inst)</dt>
+ <dd>Installation path of the Office.</dd>
+ <dt>\$(prog)</dt>
+ <dd>Program path of the Office.</dd>
+ <dt>\$(user)</dt>
+ <dd>The user installation directory.</dd>
+ <dt>\$(work)</dt>
+ <dd>The work directory of the user. Under Windows this would be the
"MyDocuments" subdirectory. Under Unix this would be the home-directory</dd>
- <dt>$(home)</dt>
- <dd>The home directory of the user. Under Unix this would be the home-
- directory. Under Windows this would be the "Documents and Settings\<username>"
- subdirectory.</dd>
- <dt>$(temp)</dt>
- <dd>The current temporary directory.</dd>
- <dt>$(path)</dt>
- <dd>The value of PATH environment variable.</dd>
- <dt>$(lang)</dt>
- <dd>The country code used by the Office, like 01=English, 49=German.</dd>
- <dt>$(langid)</dt>
- <dd>The language code used by the Office, like 0x0009=English, 0x0409=English US.</dd>
- <dt>$(vlang)</dt>
- <dd>The language used by the Office as a string. Like "German" for a German Office.</dd>
- </dl>
- <p>
+ <dt>\$(home)</dt>
+ <dd>The home directory of the user. Under Unix this would be the home-
+ directory. Under Windows this would be the "Documents and Settings\<username>"
+ subdirectory.</dd>
+ <dt>\$(temp)</dt>
+ <dd>The current temporary directory.</dd>
+ <dt>\$(path)</dt>
+ <dd>The value of PATH environment variable.</dd>
+ <dt>\$(lang)</dt>
+ <dd>The country code used by the Office, like 01=English, 49=German.</dd>
+ <dt>\$(langid)</dt>
+ <dd>The language code used by the Office, like 0x0009=English, 0x0409=English US.</dd>
+ <dt>\$(vlang)</dt>
+ <dd>The language used by the Office as a string. Like "German" for a German Office.</dd>
+ </dl>
+ <p>
Attention: Most predefined variables describe an absolute path.
- The only exceptions are: $(lang), $(langid) and $(vlang).
+ The only exceptions are: \$(lang), \$(langid) and \$(vlang).
Therefore the service implementation should only substitute variables which
are located at the start of a provided path string or are part of a multi-path.
This special service is not designed to be a text substiution but shall
provide (a) valid substituted path(s).
- </p>
+ </p>
@since OOo 1.1.2
*/
commit 7776a2efb8ba5658e6ad01870ecd80e380cbc619
Author: Michael Stahl <mstahl at redhat.com>
Date: Wed May 1 18:54:37 2013 +0200
*api: document all modules in modules.idl
Change-Id: I1c0c89f515f06bd14b659836d777aa705a6f03d6
diff --git a/offapi/com/sun/star/modules.idl b/offapi/com/sun/star/modules.idl
index a379e80..d7bf65d 100644
--- a/offapi/com/sun/star/modules.idl
+++ b/offapi/com/sun/star/modules.idl
@@ -19,13 +19,12 @@
#ifndef __com_sun_star_modules_idl__
#define __com_sun_star_modules_idl__
-module com { module sun { module star {
-
-/// security and authenticates interfaces
-module auth {};
+/* note: this file contains documentation of the modules.
+ sub-modules of modules are documented here too so there aren't
+ lots of tiny documentation only files everywhere.
+*/
-/// Java AWT-like user interface toolkit interface specifications for UNO.
-module awt {};
+module com { module sun { module star {
/** UNO Accessibility API
@@ -57,6 +56,26 @@ module awt {};
*/
module accessibility {};
+/// interfaces for SMIL animations.
+module animations {};
+
+/// security and authenticates interfaces
+module auth {};
+
+/// Java AWT-like user interface toolkit interface specifications for UNO.
+module awt {
+
+ /// grid control.
+ module grid {};
+
+ /// tab pages.
+ module tab {};
+
+ /// hierarchical (tree) control.
+ module tree {};
+
+};
+
/// Charting diagram interfaces.
module chart {};
@@ -64,31 +83,104 @@ module chart {};
contains only a rather small public API. In addition there is a
private API in the chart2 project.
*/
-module chart2 {};
+module chart2 {
+
+ /// Chart data provider interfaces.
+ module data {};
+};
/// Access to the tree of configuration data.
-module configuration {};
+module configuration {
+
+ /// interfaces for configuration backends.
+ module backend {
+ /// XML files backend.
+ module xml {};
+ };
+
+ /// deprecated bootstrapping mechanism.
+ module bootstrap {};
+
+};
+
+/// TODO: what is this?
+module cui {};
/// Clipboard and Drag&Drop interfaces.
-module datatransfer {};
+module datatransfer {
+
+ /// Clipboard specific interfaces.
+ module clipboard {};
+
+ /// Drag&Drop specific interfaces.
+ module dnd {};
+
+};
+
+/// interfaces for extension management.
+module deployment {
+
+ // this looks like it should not be documented
+ module test {};
+
+ /// interfaces for extension management dialogs.
+ module ui {};
+
+};
/// Office document related interfaces.
module document {};
-/// Office document content related interfaces.
-module office {};
-
/// Drawing and shape specific interfaces.
-module drawing {};
+module drawing {
+
+ /// Draw/Impress user interface framework.
+ module framework {};
+
+};
+
+/// interfaces related to embedded objects, both native UNO and OLE.
+module embed {};
/// Interfaces for managing forms and controls.
-module form {};
+module form {
+
+ /// form bindings.
+ module binding {};
+
+ /// form components (model part of the controls).
+ module component {};
+
+ /// form components (view part of the controls).
+ module control {};
+
+ /// various property handlers for forms.
+ module inspection {};
+
+ /// core components of forms.
+ module runtime {};
+
+ /// for submission of data from forms.
+ module submission {};
+
+ /// for validation of form data.
+ module validation {};
+
+};
/// Interfaces for mathematical formulas.
module formula {};
/// Desktop environment framework interfaces.
-module frame {};
+module frame {
+
+ /// various status properties.
+ module status {};
+
+};
+
+/// interfaces for galleries of images and media objects.
+module gallery {};
/// Interfaces and data types to deal with basic geometric entities
module geometry {};
@@ -100,12 +192,21 @@ module graphic {};
subject to change. */
module i18n {};
+/// interfaces for HTML image maps.
+module image {};
+
+/// interfaces for inspecting UNO objects via property handlers.
+module inspection {};
+
/// lightweight directory access protocol (LDAP)
module ldap {};
/// Spell checker, hyphenation and thesaurus interfaces.
module linguistic2 {};
+/// logging of events.
+module logging {};
+
/// Interfaces for Email connectivity
module mail {};
@@ -115,26 +216,118 @@ module media {};
/// Interfaces for Mozilla integration.
module mozilla {};
+/// Office document content related interfaces.
+module office {};
+
+/// Package file format interfaces.
+module packages {
+
+ /// interfaces for reading and writing manifest.xml files in ODF packages.
+ module manifest {};
+
+ /// for direct access to ZIP packages.
+ module zip {};
+
+};
+
/// Netscape-like plugin interfaces.
module plugin {};
/// Presentation specific interfaces.
-module presentation {};
+module presentation {
+
+ /// for text fields in presentation documents.
+ module textfield {};
+
+};
+
+/// Interfaces for QA and automated tests
+module qa {};
+
+/** RDF (Resource Description Framework) and metadata interfaces.
+
+ <p>
+ This module provides interfaces for storing and accessing metadata
+ in <a href="http://www.w3.org/RDF/">Resource Description Framework</a>
+ format.
+ The API consists of two main parts: the RDF data model and the ODF
+ document integration.
+ </p>
+
+ <p>
+ The <a href="http://www.w3.org/TR/rdf-concepts/">RDF data model</a>
+ describes graphs of statements.
+ The nodes in the graph are of type rdf::XNode,
+ which has several subtypes: rdf::XResource,
+ rdf::XBlankNode,
+ rdf::XURI and rdf::XLiteral.
+ Statements are then triples of nodes, and have type
+ rdf::Statement.
+ </p>
+
+ <p>
+ The main part of the RDF data model is the
+ rdf::XRepository, which consists of a set of graphs.
+ The repository allows for importing/exporting graphs from/to files,
+ as well as querying the contents of the repository.
+ The type of the graphs is rdf::XNamedGraph.
+ </p>
+
+ <p>
+ Documents that support metadata implement the interfaces
+ rdf::XRepositorySupplier and
+ rdf::XDocumentMetadataAccess.
+ Furthermore, all elements of ODF documents that may have metadata attached
+ implement the interface rdf::XMetadatable.
+ </p>
+
+ */
+module rdf {};
/// Interfaces and data structures for rendering
module rendering {};
+/// interfaces for reports generated from data sources.
+module report {
+
+ /// property handlers for reports.
+ module inspection {};
+
+ /// report meta data.
+ module meta {};
+
+};
+
/// Interfaces to access (UI) resource files.
module resource {};
-/// Interfaces for QA and automated tests
-module qa {};
-
/// Interfaces for scanner control.
module scanner {};
+/// Scripting language bindings.
+module script {
+
+ /// manage available scripts in some sort of hierarchy.
+ module browse {};
+
+ /// interfaces for scripting providers.
+ module provider {};
+
+ /// VBA scripting.
+ module vba {};
+
+};
+
/// Basic interfaces for database access.
-module sdb {};
+module sdb {
+
+ /// application UI.
+ module application {};
+
+ /// misc stuff.
+ module tools {};
+
+};
/// Database component interfaces.
module sdbc {};
@@ -142,15 +335,27 @@ module sdbc {};
/// High-level database component interfaces.
module sdbcx {};
+/// cryptographic interfaces.
+module security {};
+
+/// TODO: what is this?
+module setup {};
+
/// Spreadsheet specific interfaces.
module sheet {};
+/// allows to put smart tags in document content.
+module smarttags {};
+
/// Formatting and layout style and style sheet interfaces.
module style {};
/// Interfaces for import/export of Scaleable Vector Format.
module svg {};
+/// Host operating system integration interfaces.
+module system {};
+
/// Table specific interfaces (for text and spreadsheet).
module table {};
@@ -158,13 +363,31 @@ module table {};
module task {};
/// Text specific interfaces.
-module text {};
+module text {
+
+ /// text field masters.
+ module fieldmaster {};
+
+ /// text fields.
+ module textfield {
+
+ /// Document Properties text fields.
+ module docinfo {};
+
+ };
+
+};
/// Universal Content Broker interfaces.
module ucb {};
/// Dialogs and other UI elements.
-module ui {};
+module ui {
+
+ /// dialogs.
+ module dialogs {};
+
+};
/// Miscellaneous interfaces for sorting, connecting objects etc.
module util {};
@@ -172,63 +395,53 @@ module util {};
/// Document view specific interfaces (e.g. selection access and printing).
module view {};
+/// interfaces for XForms (XML-based forms) implementation
+module xforms {};
+
/// XML related interfaces.
-module xml {};
+module xml {
-/// Host operating system integration interfaces.
-module system {};
+ /// XML encryption interfaces.
+ module crypto {
-/// Package file format interfaces.
-module packages {};
+ /// XML encryption SAX interfaces.
+ module sax {};
-/// image manipulation interfaces.
-module image {};
+ };
-/// interfaces for XForms (XML-based forms) implementation
-module xforms {};
+ /// Compressed SAX interfaces.
+ module csax {};
-/// interfaces for report interfaces
-module report {};
+ /// XML Document Object Model.
+ module dom {
-/** RDF (Resource Description Framework) and metadata interfaces.
+ /// XML Document Object Model events.
+ module events {};
- <p>
- This module provides interfaces for storing and accessing metadata
- in <a href="http://www.w3.org/RDF/">Resource Description Framework</a>
- format.
- The API consists of two main parts: the RDF data model and the ODF
- document integration.
- </p>
+ /// XML Document Object Model views.
+ module views {};
- <p>
- The <a href="http://www.w3.org/TR/rdf-concepts/">RDF data model</a>
- describes graphs of statements.
- The nodes in the graph are of type rdf::XNode,
- which has several subtypes: rdf::XResource,
- rdf::XBlankNode,
- rdf::XURI and rdf::XLiteral.
- Statements are then triples of nodes, and have type
- rdf::Statement.
- </p>
+ };
- <p>
- The main part of the RDF data model is the
- rdf::XRepository, which consists of a set of graphs.
- The repository allows for importing/exporting graphs from/to files,
- as well as querying the contents of the repository.
- The type of the graphs is rdf::XNamedGraph.
- </p>
+ /// no idea what this does but it's all marked "internal".
+ module input {};
- <p>
- Documents that support metadata implement the interfaces
- rdf::XRepositorySupplier and
- rdf::XDocumentMetadataAccess.
- Furthermore, all elements of ODF documents that may have metadata attached
- implement the interface rdf::XMetadatable.
- </p>
+ /// SAX interfaces.
+ module sax {};
- */
-module rdf {};
+ /// something related to creating DOMs from SAX interfaces?
+ module wrapper {};
+
+ /// XPath interfaces.
+ module xpath {};
+
+ /// XSLT interfaces.
+ module xslt {};
+
+};
+
+/// W3C XML Schema-2 data type related interfaces.
+module xsd {};
}; }; };
diff --git a/udkapi/com/sun/star/udk-modules.idl b/udkapi/com/sun/star/udk-modules.idl
index d33104b..ad20cdf 100644
--- a/udkapi/com/sun/star/udk-modules.idl
+++ b/udkapi/com/sun/star/udk-modules.idl
@@ -19,13 +19,26 @@
#ifndef __com_sun_star_modules_idl__
#define __com_sun_star_modules_idl__
-module com { module sun { module star {
+/* note: this file contains documentation of the modules.
+ sub-modules of modules are documented here too so there aren't
+ lots of tiny documentation only files everywhere.
+*/
+
+module com { module sun {
+
+/// the module com::sun::star is the root module of the UNO API.
+module star {
/// Java beans-like property access and introspection.
-module beans{};
+module beans {};
/// Interfaces for building bridges to other component models.
-module bridge {};
+module bridge {
+
+ /// interfaces for UNO bridge to OLE automation.
+ module oleautomation {};
+
+};
/// Data exchange interfaces for inter-process communication.
module connection {};
commit e9f5fb0f996b41e976a77c7df30c7c2f6d446f41
Author: Michael Stahl <mstahl at redhat.com>
Date: Wed May 1 00:31:39 2013 +0200
*api: fix more bad <pre> (tweak monster comment in Content.idl)
Change-Id: Ibedb43cf201013a7c5da6001d8a3cb4866e5ecb4
diff --git a/offapi/com/sun/star/ucb/Content.idl b/offapi/com/sun/star/ucb/Content.idl
index 89877eb..77787af 100644
--- a/offapi/com/sun/star/ucb/Content.idl
+++ b/offapi/com/sun/star/ucb/Content.idl
@@ -78,7 +78,7 @@ published service Content
<p>This interface is required. </p>
- <pre>
+ @code{.idl}
=======================================================================
Commands:
=======================================================================
@@ -110,7 +110,7 @@ published service Content
// column instead.
com::sun::star::sdbc::XRow
getPropertyValues
- sequence< com::sun::star::beans::Property > aProps
+ sequence< com::sun::star::beans::Property > aProps
// This command sets property values of the content.
// Note that setPropertyValues does not throw an exception in the case
@@ -144,9 +144,9 @@ published service Content
// transporting the error code IOErrorCode::ACCESS_DENIED.
// If the value to set is equal to the current value, no exception must
// be added to the returned sequence
- sequence< any >
+ sequence< any >
setPropertyValues
- sequence< com::sun::star::beans::PropertyValue > aValues
+ sequence< com::sun::star::beans::PropertyValue > aValues
-----------------------------------------------------------------------
Optional commands:
@@ -170,7 +170,7 @@ published service Content
// (by throwing a CommandAbortedException), if an
// unsupported mode is requested.
XDynamicResultSet
- <B>open</B>
+ open
OpenCommandArgument2 aOpenCommandArg
// For non-folder objects, the OpenCommandArgument2 struct
@@ -189,7 +189,7 @@ published service Content
// (by throwing a CommandAbortedException), if an
// unsupported mode is requested.
void
- <B>open</B>
+ open
OpenCommandArgument2 aOpenCommandArg
// This command triggers an update operation on a content. For example,
@@ -198,7 +198,7 @@ published service Content
// contents will be notified by calling
// XContentEventListener::contentEvent().
void
- <B>update</B>
+ update
OpenCommandArgument2 aOpenCommandArg
// This command triggers a synchronization operation between locally
@@ -209,12 +209,12 @@ published service Content
// be notified by calling
// XContent::contentEvent().
void
- <B>synchronize</B>
+ synchronize
OpenCommandArgument2 aOpenCommandArg
// This command closes an object.
void
- <B>close</B>
+ close
void
// This command deletes an object. If `TRUE` is passed as parameter,
@@ -227,14 +227,14 @@ published service Content
// parent must notify a ContentEvent
// - ContentAction::REMOVED
void
- <B>delete</B>
+ delete
boolean bDeletePhysically
// This command restores an object previously deleted into trash. It
// must be supported by objects which claim to be undeletable, but
// should never be called directly.
void
- <B>undelete</B>
+ undelete
void
// (1) This command inserts a new content. It commits the process of
@@ -255,17 +255,17 @@ published service Content
// (2) Additionally this command can be called at any time to overwrite
// the data of an existing content.
void
- <B>insert</B>
+ insert
InsertCommandArgument aInsertCommandArg
// This command searches for subcontents of a content matching the
// given search criteria. The command will return an implementation
// of service DynamicResultSet.
XDynamicResultSet
- <B>search</B>
+ search
SearchCommandArgument aSearchCommandArg
- // <b>Important note:</b> A client that wants to transfer data should
+ // *** Important note: *** A client that wants to transfer data should
// not execute this command, but it should execute the command
// "globalTransfer" at the UniversalContentBroker.
// This command is able to transfer all kind of content
@@ -300,7 +300,7 @@ published service Content
// This mechanism should work for all transfer operations, but generally
// it's less efficient than the transfer command.
void
- <B>transfer</B>
+ transfer
TransferInfo aTransferInfo
// This command obtains an exclusive write lock for the resource. The
@@ -308,7 +308,7 @@ published service Content
// session that obtained the lock ends or until the lock is released by
// a third party (e.g. a system administrator).
void
- <B>lock</B>
+ lock
void
Exceptions: InteractiveLockingLockedException
InteractiveLockingLockExpiredException
@@ -316,7 +316,7 @@ published service Content
// This command removes a lock obtained by executing the command "lock"
// from the resource.
void
- <B>unlock</B>
+ unlock
void
Exceptions: InteractiveLockingNotLockedException
InteractiveLockingLockExpiredException
@@ -325,24 +325,24 @@ published service Content
// be raised by any command that requires a previously obtained lock.
// This command creates a new non-persistent content of a given type.
- // <p>Creation of a new (persistent) content:
- // <ol>
- // <li>creatabletypes = obtain "CreatableContentsInfo" property<br>
+ // Creation of a new (persistent) content:
+ //
+ // 1. creatabletypes = obtain "CreatableContentsInfo" property
// from creator
- // <li>choose a suitable type from creatabletypes
- // <li>newObject = execute command "createNewContent(type)" at<br>
+ // 2. choose a suitable type from creatabletypes
+ // 3. newObject = execute command "createNewContent(type)" at
// creator
- // <li>initialize the new object (i.e. newObject.Property1 = ...)
- // <li>execute command "insert" at new content. This command
+ // 4. initialize the new object (i.e. newObject.Property1 = ...)
+ // 5. execute command "insert" at new content. This command
// commits the data and makes the new content persistent.
- // </ol>
+ //
// This command must be supported by every Content that supports the
// property "CreatableContentsInfo" if the returned property value
// contains a non-empty sequence of creatable types.
// Note: This command is part of the replacement for the deprecated
// interface XContentCreator.
- XContent >
- <B>createNewContent</B>
+ XContent
+ createNewContent
ContentInfo content info
=======================================================================
@@ -371,7 +371,7 @@ published service Content
boolean IsDocument
// contains the title of an object (e.g. the subject of a message).
- string Title;
+ string Title
-----------------------------------------------------------------------
Optional properties:
@@ -398,7 +398,7 @@ published service Content
com::sun::star::util::DateTime DateModified
// contains the count of documents of a folder.
- long DocumentCount;
+ long DocumentCount
// contains the count of marked documents within a folder.
long DocumentCountMarked
@@ -406,8 +406,8 @@ published service Content
// contains a sequence of document header fields (i.e. header
// fields of a MIME-message, or the document info of an
// office document ). For some standard header fields there
- // are predefined separate properties, like "MessageTo".
- sequence< DocumentHeaderField > DocumentHeader
+ // are predefined separate properties, like "MessageTo".
+ sequence< DocumentHeaderField > DocumentHeader
// contains information about the way a folder stores the
// contents of (remote) documents.
@@ -425,11 +425,11 @@ published service Content
// indicates whether a content has subcontents, which are folders.
boolean HasFolders
- // indicates whether a content is "marked".
+ // indicates whether a content is "marked".
boolean IsMarked
// indicates whether a content has been "read".
- boolean IsRead;
+ boolean IsRead
// indicates whether a content is read-only.
boolean IsReadOnly
@@ -439,7 +439,7 @@ published service Content
// indicates whether the feature to store contents depending on
// their age is active.
- boolean IsTimeLimitedStore;
+ boolean IsTimeLimitedStore
// indicates whether (sub)contents shall be automatically updated
// everytime a (folder) content is opened. This property may be
@@ -449,7 +449,7 @@ published service Content
boolean UpdateOnOpen
// contains the keywords of a document (e.g. the value
- // of the "keywords" header field of a news article).
+ // of the "keywords" header field of a news article).
string Keywords
// contains the media type ( MIME type ) of a content. It is highly
@@ -470,10 +470,10 @@ published service Content
// contains the ID of a message.
string MessageId
- // contains the "In-Reply-To" field of a message.
+ // contains the "In-Reply-To" field of a message.
string MessageInReplyTo
- // contains the "Reply-To" field of a message.
+ // contains the "Reply-To" field of a message.
string MessageReplyTo
// contains the recipient(s) of a message.
@@ -489,7 +489,7 @@ published service Content
// contains a priority (i.e. of a message).
Priority Priority
- // contains the "References" field of a news article.
+ // contains the "References" field of a news article.
string References
// contains the rules set for a content.
@@ -499,7 +499,7 @@ published service Content
long SeenCount
// contains the base directory to use on a server. (e.g. Setting
- // the server base of an FTP-Account to "/pub/incoming"
+ // the server base of an FTP-Account to "/pub/incoming"
// will result in showing contents from that directory and not from
// server's root directory)
string ServerBase
@@ -527,27 +527,19 @@ published service Content
// contains information about the target frame to use when displaying
// an object.
- <p>The value is a string containing three tokens, separated by ";"
- (A semicolon):<br/>
- <dl>
- <dt>1st token
- </dt><dd>Behavior on "select" ( single click )
- </dd><dt>2nd token
- </dt><dd>Behavior on "open" ( double click )
- </dd><dt>3rd token
- </dt><dd>Behavior on "open in new task" ( double click + CTRL key )
- </dd></dl>
- </p>
- <p> Each token may contain the following values:<br/>
- <dl>
- <dt>"_beamer"
- </dt><dd>Show in "Beamer"
- </dd><dt>"_top"
- </dt><dd>Show in current frame (replaces old)
- </dd><dt>"_blank"
- </dt><dd>Show in new task
- </dd></dl>
- </p>
+ // The value is a string containing three tokens, separated by ";"
+ // (A semicolon):
+ //
+ // 1st token: Behavior on "select" ( single click )
+ // 2nd token: Behavior on "open" ( double click )
+ // 3rd token: Behavior on "open in new task" ( double click + CTRL key )
+ //
+ // Each token may contain the following values:
+ //
+ // "_beamer": Show in "Beamer"
+ // "_top": Show in current frame (replaces old)
+ // "_blank": Show in new task
+ //
string TargetFrames
// for contents that are links to other contents, contains the URL of
@@ -555,7 +547,7 @@ published service Content
string TargetURL
// contains the value to use if the property "IsTimeLimitedStore" is set.
... etc. - the rest is truncated
More information about the Libreoffice-commits
mailing list