Skip to content

Commit e031a38

Browse files
ebarboniebarboni
authored
Merge pull request #8263 from ebarboni/apidocjdkjson
Use pseudo module for apidoc generation and honor json parameter
2 parents 7302357 + a5a18b9 commit e031a38

File tree

84 files changed

+667
-328
lines changed

Some content is hidden

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

84 files changed

+667
-328
lines changed

‎apisupport/apisupport.project/arch.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -633,11 +633,11 @@
633633
<api name="org.netbeans.ui.apisupport.DEPENDENCIES" category="friend" group="logger" type="export">
634634
There is a special support for notifying the UI gestures collector
635635
about the usage of NetBeans APIs. When a project customizer is closed,
636-
the modules sends to <a href="@JDK@/java/util/logging/Logger.html">
636+
the modules sends to <a href="@JDK@@JDKMODULE_JAVA_LOGGING@/java/util/logging/Logger.html">
637637
Logger.getLogger("org.netbeans.ui.apisupport")
638-
</a> a <a href="@JDK@/java/util/logging/LogRecord.html">LogRecord</a>
638+
</a> a <a href="@JDK@@JDKMODULE_JAVA_LOGGING@/java/util/logging/LogRecord.html">LogRecord</a>
639639
with message <code>DEPENDENCIES</code>,
640-
<code>CONFIG</code> <a href="@JDK@/java/util/logging/LogRecord.html">level</a>
640+
<code>CONFIG</code> <a href="@JDK@@JDKMODULE_JAVA_LOGGING@/java/util/logging/LogRecord.html">level</a>
641641
and paramerters being the code name bases of modules that start with
642642
<code>org.openide</code> or <code>org.netbeans</code>.
643643
This message can then be consumed
@@ -646,7 +646,7 @@
646646
</api>
647647
<api name="org.openide.awt.ActionReference.completion" category="devel" group="systemproperty" type="import">
648648
<code>apisupport.project</code> registers a
649-
<a href="@JDK@/javax/annotation/processing/Processor.html">Processor</a>
649+
<a href="@JDK@@JDKMODULE_JAVA_COMPILER@/javax/annotation/processing/Processor.html">Processor</a>
650650
implementation to provide
651651
items representing valid paths in current project for
652652
<a href="@org-openide-awt@/org/openide/awt/ActionReference.html#path()">

‎ergonomics/ide.ergonomics/arch.xml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -584,13 +584,13 @@
584584
<ul>
585585
<li>
586586
<api name="org.netbeans.ui.ergonomics.ERGO_QUESTION" category="friend" group="logger" type="export">
587-
Logged to <a href="@JDK@/java/util/logging/Logger.html">
587+
Logged to <a href="@JDK@@JDKMODULE_JAVA_LOGGING@/java/util/logging/Logger.html">
588588
Logger.getLogger("org.netbeans.ui.ergonomics")
589589
</a> to signal that a user of the system has been faced with: <q>
590590
Activate this functonality?</q> question. The structure of the
591-
<a href="@JDK@/java/util/logging/LogRecord.html">LogRecord</a>
591+
<a href="@JDK@@JDKMODULE_JAVA_LOGGING@/java/util/logging/LogRecord.html">LogRecord</a>
592592
composes of message <code>ERGO_QUESTION</code>,
593-
<code>FINE</code> <a href="@JDK@/java/util/logging/LogRecord.html">level</a>
593+
<code>FINE</code> <a href="@JDK@@JDKMODULE_JAVA_LOGGING@/java/util/logging/LogRecord.html">level</a>
594594
and paramerters:
595595
<ul>
596596
<li>{<b>0</b>} cluster name to install</li>
@@ -602,28 +602,28 @@
602602
</li>
603603
<li>
604604
<api name="org.netbeans.ui.ergonomics.ERGO_DOWNLOAD" category="friend" group="logger" type="export">
605-
Logged to <a href="@JDK@/java/util/logging/Logger.html">
605+
Logged to <a href="@JDK@@JDKMODULE_JAVA_LOGGING@/java/util/logging/Logger.html">
606606
Logger.getLogger("org.netbeans.ui.ergonomics")
607607
</a> to signal that a user of the system agreed to download or activate
608608
the functionality.
609609
</api>
610610
</li>
611611
<li>
612612
<api name="org.netbeans.ui.ergonomics.ERGO_CLOSE" category="friend" group="logger" type="export">
613-
Logged to <a href="@JDK@/java/util/logging/Logger.html">
613+
Logged to <a href="@JDK@@JDKMODULE_JAVA_LOGGING@/java/util/logging/Logger.html">
614614
Logger.getLogger("org.netbeans.ui.ergonomics")
615615
</a> to signal that all user interaction with ergonomics subsystem is over.
616616
</api>
617617
</li>
618618
<li>
619619
<api name="org.netbeans.ui.ergonomics.ERGO_OPEN_PROJECT" category="friend" group="logger" type="export">
620-
Logged to <a href="@JDK@/java/util/logging/Logger.html">
620+
Logged to <a href="@JDK@@JDKMODULE_JAVA_LOGGING@/java/util/logging/Logger.html">
621621
Logger.getLogger("org.netbeans.ui.ergonomics")
622622
</a> to signal that a user of the system activated new functionality
623623
by opening an existing project.The structure of the
624-
<a href="@JDK@/java/util/logging/LogRecord.html">LogRecord</a>
624+
<a href="@JDK@@JDKMODULE_JAVA_LOGGING@/java/util/logging/LogRecord.html">LogRecord</a>
625625
composes of message <code>ERGO_OPEN_PROJECT</code>,
626-
<code>FINE</code> <a href="@JDK@/java/util/logging/LogRecord.html">level</a>
626+
<code>FINE</code> <a href="@JDK@@JDKMODULE_JAVA_LOGGING@/java/util/logging/LogRecord.html">level</a>
627627
and paramerters:
628628
<ul>
629629
<li>{<b>0</b>} cluster name to install</li>

‎ide/api.java.classpath/src/org/netbeans/api/java/classpath/package.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ <h2><a name="roots-definition">Roots and definition of the classpath</a></h2>
125125
<div class="nonnormative">
126126
<pre>
127127
<a href="ClassPath.html"><font class="type">ClassPath</font></a> <font class="variable-name">cp</font> = ClassPath.<a href="ClassPath.html#getClassPath-org.openide.filesystems.FileObject-java.lang.String-"><font class="function-name">getClassPath</font></a>(myClassObject, ClassPath.<a href="ClassPath.html#EXECUTE"><font class="constant">EXECUTE</font></a>);
128-
<a href="@JDK@/java/util/List.html"><font class="type">List</font></a> <font class="variable-name">entries</font> = cp.<a href="ClassPath.html#entries--"><font class="function-name">entries</font></a>();
128+
<a href="@JDK@@JDKMODULE_JAVA_BASE@/java/util/List.html"><font class="type">List</font></a> <font class="variable-name">entries</font> = cp.<a href="ClassPath.html#entries--"><font class="function-name">entries</font></a>();
129129
<font class="keyword">for</font> (Iterator <font class="variable-name">it</font> = entries.iterator(); it.hasNext(); ) {
130130
<a href="ClassPath.Entry.html"><font class="type">ClassPath.Entry</font></a> <font class="variable-name">en</font> = (ClassPath.Entry)it.next();
131131
<font class="keyword">if</font> (!en.<a href="ClassPath.Entry.html#isValid--"><font class="function-name">isValid()</font></a>) {
@@ -190,9 +190,9 @@ <h2><a name="change-listen">Listening to changes in ClassPath</a></h2>
190190
<pre>
191191
<a href="@org-openide-filesystems@/org/openide/filesystems/FileObject.html"><font class="type">FileObject</font></a> <font class="variable-name">f</font>; <font class="comment">// some interesting FileObject.</font>
192192
<a href="ClassPath.html"><font class="type">ClassPath</font></a> <font class="variable-name">cp</font> = ClassPath.<a href="ClassPath.html#getClassPath-org.openide.filesystems.FileObject-java.lang.String-"><font class="function-name">getClassPath</font></a>(f, ClassPath.<a href="ClassPath.html#COMPILE"><font class="constant">COMPILE</font></a>);
193-
cp.<a href="ClassPath.html#addPropertyChangeListener-java.beans.PropertyChangeListener-"><font class="function-name">addPropertyChangeListener</font></a>(new <a href="@JDK@/java/beans/PropertyChangeListener.html"><font class="type">PropertyChangeListener</font></a>() {
194-
<font class="keyword">public void</font> <font class="function-name">propertyChange</font>(<a href="@JDK@/java/beans/PropertyChangeEvent.html"><font class="type">PropertyChangeEvent</font></a> <font class="variable-name">evt</font>) {
195-
<font class="keyword">if</font> (ClassPath.<a href="ClassPath.html#PROP_ROOTS"><font class="constant">PROP_ROOTS</font></a>.equals(evt.<a href="@JDK@/java/beans/PropertyChangeEvent.html#getPropertyName--"><font class="function-name">getPropertyName()</font></a>)) {
193+
cp.<a href="ClassPath.html#addPropertyChangeListener-java.beans.PropertyChangeListener-"><font class="function-name">addPropertyChangeListener</font></a>(new <a href="@JDK@@JDKMODULE_JAVA_DESKTOP@/java/beans/PropertyChangeListener.html"><font class="type">PropertyChangeListener</font></a>() {
194+
<font class="keyword">public void</font> <font class="function-name">propertyChange</font>(<a href="@JDK@@JDKMODULE_JAVA_DESKTOP@/java/beans/PropertyChangeEvent.html"><font class="type">PropertyChangeEvent</font></a> <font class="variable-name">evt</font>) {
195+
<font class="keyword">if</font> (ClassPath.<a href="ClassPath.html#PROP_ROOTS"><font class="constant">PROP_ROOTS</font></a>.equals(evt.<a href="@JDK@@JDKMODULE_JAVA_DESKTOP@/java/beans/PropertyChangeEvent.html#getPropertyName--"><font class="function-name">getPropertyName()</font></a>)) {
196196
<font class="comment">// Update your stuff, because classpath roots have changed.</font>
197197
}
198198
}

‎ide/api.xml/arch.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -422,7 +422,7 @@ as plain string. It could be replaced by a map.
422422
<answer id="format-clipboard">
423423
Implementations of cut, copy and paste (<code>CutAction</code>, <code>CopyAction</code>
424424
and <code>PasteAction</code>) reads/writes from/into clipboard. It uses standard
425-
<a href="@JDK@/java/awt/datatransfer/package-summary.html">java datatransfer mechanism</a>
425+
<a href="@JDK@@JDKMODULE_JAVA_DATATRANSFER@/java/awt/datatransfer/package-summary.html">java datatransfer mechanism</a>
426426
and <a href="@org-openide-util-ui@/org/openide/util/datatransfer/package-summary.html">Netbeans extension to the mechanism</a>.
427427
</answer>
428428

‎ide/editor.completion/arch.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -652,7 +652,7 @@
652652
<answer id="exec-property">
653653
<api category="devel" group="logger" name="org.netbeans.ui.editor.completion" type="export">
654654
Since version 1.8 the completion cooperates with <!-- XXX link to @org-netbeans-modules-uihandler@/overview-summary.html not OK from a stable API -->UI Gestures Collector
655-
by sending following messages to the <code>org.netbeans.ui.editor.completion</code> <a href="@JDK@/java/util/logging/Logger.html">logger</a>:
655+
by sending following messages to the <code>org.netbeans.ui.editor.completion</code> <a href="@JDK@@JDKMODULE_JAVA_LOGGING@/java/util/logging/Logger.html">logger</a>:
656656
<ul>
657657
<li><b>COMPL_INVOCATION</b> - message about a code completion being invoked. Arguments:
658658
<ul>

‎ide/editor.guards/arch.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
<answer id="arch-overall">
5151
<p>
5252
<api group="java" name="GuardedSectionsAPI" type="export" category="official">
53-
The Guarded Sections module is supposed to operate over the Swing's <a href="@JDK@/javax/swing/text/StyledDocument.html"><code>StyledDocument</code></a>.
53+
The Guarded Sections module is supposed to operate over the Swing's <a href="@JDK@@JDKMODULE_JAVA_DESKTOP@/javax/swing/text/StyledDocument.html"><code>StyledDocument</code></a>.
5454
It allows clients to manipulate named guarded sections that prevents user to
5555
modify the content. So if you like to create, modify or delete guarded sections the <a href="@org-netbeans-modules-editor-guards@/org/netbeans/api/editor/guards/GuardedSectionManager.html">
5656
<code>GuardedSectionManager</code></a> is the best place where to start.

‎ide/editor.lib2/src/org/netbeans/api/editor/caret/package.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ <h3>Locking and <code>Document</code> changes</h3>
7171
<p>
7272
The basics of the locking and events model of Swing documents is
7373
described in the javadoc of the
74-
<a href="@JDK@/javax/swing/text/AbstractDocument.html">javax.swing.text.AbstractDocument</a>
74+
<a href="@JDK@@JDKMODULE_JAVA_DESKTOP@/javax/swing/text/AbstractDocument.html">javax.swing.text.AbstractDocument</a>
7575
class. Netbeans documents use the same patterns and so does the Caret API,
7676
because of its tight relation to documents. The fundamentals of the Swing documents
7777
locking model are that any changes to a document are done under the
@@ -111,7 +111,7 @@ <h3>Locking and <code>Document</code> changes</h3>
111111

112112
<h3><a name="movement-origins">Reason of Caret Movement</a></h3>
113113
<p>
114-
It may be desirable (especially for <a href="@JDK@/javax/swing/text/NavigationListener.html">NavigationListeners</a>, but possibly for
114+
It may be desirable (especially for <a href="@JDK@@JDKMODULE_JAVA_DESKTOP@/javax/swing/text/NavigationListener.html">NavigationListeners</a>, but possibly for
115115
<a href="EditorCaretListener.html">EditorCaretListeners</a> too) to determine
116116
what was the reason leading to caret movement. The caller of Caret API which intends to position the caret
117117
may provide an optional <a href="MoveCaretsOrigin.html">MoveCaretsOrigin</a> instance to Caret API methods to indicate
@@ -129,10 +129,10 @@ <h3><a name="movement-origins">Reason of Caret Movement</a></h3>
129129
<h3><a name="navigation-filters">Navigation Filters</a></h3>
130130
<p>
131131
The Caret API implements and extends the concept of swing
132-
<a href="@JDK@/javax/swing/text/NavigationFilter.html">NavigationFilters</a>. The Filter
132+
<a href="@JDK@@JDKMODULE_JAVA_DESKTOP@/javax/swing/text/NavigationFilter.html">NavigationFilters</a>. The Filter
133133
gets notified on <code>CaretInfo</code> movement; so if more Carets are present,
134134
a <code>NavigationFilter</code> will see all their moves. Navigation Filters are
135-
called with a special instance of <a href="@JDK@/javax/swing/text/NavigationFilter.FilterBypass.html">
135+
called with a special instance of <a href="@JDK@@JDKMODULE_JAVA_DESKTOP@/javax/swing/text/NavigationFilter.FilterBypass.html">
136136
FilterBypass</a> extending <a href="../../../spi/editor/caret/NavigationFilterBypass.html">
137137
NavigationFilterBypass</a>. The Filter <b>can downcast the FilterBypass to access extended information</b>
138138
about the current caret's movement:
@@ -191,7 +191,7 @@ <h3><a name="navigation-filters">Navigation Filters</a></h3>
191191
</code>
192192
</pre>
193193
</div>
194-
Swing NavigationFilters, specified by <a href="@JDK@/javax/swing/text/JTextComponent#setNavigationFilter(javax.swing.text.NavigationFilter)">TextComponent.setNavigationFilter()</a>
194+
Swing NavigationFilters, specified by <a href="@JDK@@JDKMODULE_JAVA_DESKTOP@/javax/swing/text/JTextComponent#setNavigationFilter(javax.swing.text.NavigationFilter)">TextComponent.setNavigationFilter()</a>
195195
are called for all caret movements.
196196
<p>
197197
Abstract boilerplate for <code>NavigationFilters</code> is created,

‎ide/editor.lib2/src/org/netbeans/spi/editor/caret/package.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,17 +53,17 @@ <h3>Key parts of the SPI</h3>
5353
<h3><a name="navigation-filters">Navigation Filters</a></h3>
5454
<p>
5555
A boilerplate <a href="CascadingNavigationFilter.html">CascadingNavigationFilter</a> is provided to
56-
make implementation of <a href="@JDK@/javax/swing/text/NavigationFilter.html">NavigationFilters</a> easier. The boilerplate
56+
make implementation of <a href="@JDK@@JDKMODULE_JAVA_DESKTOP@/javax/swing/text/NavigationFilter.html">NavigationFilters</a> easier. The boilerplate
5757
remembers the preceding filter and will delegate to it. If you create a subclass, you may call <code>super</code> methods
5858
<code>moveDot</code> and <code>setDot</code> to delegate to that previous filter and ultimately perform the action. Calling
59-
methods of <a href="@JDK@/javax/swing/text/NavigationFilter.FilterBypass.html">FilterBypass</a> will perform the caret action
59+
methods of <a href="@JDK@@JDKMODULE_JAVA_DESKTOP@/javax/swing/text/NavigationFilter.FilterBypass.html">FilterBypass</a> will perform the caret action
6060
directly.
6161
</p>
6262
<p>
6363
The filter can find out the <a href="../../../api/editor/caret/package-summary.html#movement-origins">origin of the movement</a> or
6464
the <a href="../../../api/editor/caret/CaretInfo.html"><code>CaretInfo</code> for actual caret</a> being moved. The
65-
<a href="@JDK@/javax/swing/text/NavigationFilter.FilterBypass.html">FilterBypass</a> implementation passed to
66-
<a href="@JDK@/javax/swing/text/NavigationFilter.html">NavigationFilter</a> can be downcasted to <a href="NavigationFilterBypass.html">NavigationFilterBypass</a>,
65+
<a href="@JDK@@JDKMODULE_JAVA_DESKTOP@/javax/swing/text/NavigationFilter.FilterBypass.html">FilterBypass</a> implementation passed to
66+
<a href="@JDK@@JDKMODULE_JAVA_DESKTOP@/javax/swing/text/NavigationFilter.html">NavigationFilter</a> can be downcasted to <a href="NavigationFilterBypass.html">NavigationFilterBypass</a>,
6767
which provides this extended information.
6868
</p>
6969
<h3><a name="compatibilty">Backwards compatibility</a></h3>

‎ide/editor.lib2/src/org/netbeans/spi/editor/highlighting/package.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ <h3>Locking and <code>Document</code> changes</h3>
143143
<p>
144144
The basics of the locking and events model of Swing documents is
145145
described in the javadoc of the
146-
<a href="@JDK@/javax/swing/text/AbstractDocument.html">javax.swing.text.AbstractDocument</a>
146+
<a href="@JDK@@JDKMODULE_JAVA_DESKTOP@/javax/swing/text/AbstractDocument.html">javax.swing.text.AbstractDocument</a>
147147
class. Netbeans documents use the same patterns and so does the Highlighting SPI,
148148
because of its tight relation to documents. The fundamentals of the Swing documents
149149
locking model are that any changes to a document are done under the
@@ -157,7 +157,7 @@ <h3>Locking and <code>Document</code> changes</h3>
157157
starting offset, ending offset and a set of attributes. The offsets are usually passed
158158
in and out accross the SPI boundaries in form of <code>int</code>s and even though
159159
some implementations (e.g. <code>PositionsBag</code>) use
160-
<code><a href="@JDK@/javax/swing/text/Position.html">Position</a></code>s
160+
<code><a href="@JDK@@JDKMODULE_JAVA_DESKTOP@/javax/swing/text/Position.html">Position</a></code>s
161161
the esential rule is that any calls in and out from the SPI have to be made
162162
under the document's read lock. Let's have a look on a few examples demonstrating
163163
what this means.
@@ -192,7 +192,7 @@ <h3>Locking and <code>Document</code> changes</h3>
192192
does is always done on the caller's thread. This means that the above described
193193
constraints hardly cause any limitation for practical use. The majority of
194194
things happening around a document are done from within
195-
<code><a href="@JDK@/javax/swing/event/DocumentListener.html">DocumentListener</a></code>s,
195+
<code><a href="@JDK@@JDKMODULE_JAVA_DESKTOP@/javax/swing/event/DocumentListener.html">DocumentListener</a></code>s,
196196
which hold the document's read lock anyway.
197197
</p>
198198

‎ide/lexer/arch.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -78,11 +78,11 @@ class with its static methods that provide its instance for the given input sour
7878
<p>
7979
<a href="@org-netbeans-modules-lexer@/org/netbeans/api/lexer/TokenHierarchy.html">TokenHierarchy</a>
8080
can be created for immutable input sources (
81-
<a href="@JDK@/java/lang/CharSequence.html">CharSequence</a>
81+
<a href="@JDK@@JDKMODULE_JAVA_BASE@/java/lang/CharSequence.html">CharSequence</a>
8282
or
83-
<a href="@JDK@/java/io/Reader.html">java.io.Reader</a>
83+
<a href="@JDK@@JDKMODULE_JAVA_BASE@/java/io/Reader.html">java.io.Reader</a>
8484
) or for mutable input sources (typically
85-
<a href="@JDK@/javax/swing/text/Document.html">javax.swing.text.Document</a>
85+
<a href="@JDK@@JDKMODULE_JAVA_DESKTOP@/javax/swing/text/Document.html">javax.swing.text.Document</a>
8686
).
8787
<br/>
8888
For mutable input source the lexer framework updates the tokens in the token hierarchy automatically
@@ -102,7 +102,7 @@ class with its static methods that provide its instance for the given input sour
102102
(returned by
103103
<a href="@org-netbeans-modules-lexer@/org/netbeans/api/lexer/Token.html#id--">Token.id()</a>
104104
) and a text (aka token body) represented as
105-
<a href="@JDK@/java/lang/CharSequence.html">CharSequence</a>
105+
<a href="@JDK@@JDKMODULE_JAVA_BASE@/java/lang/CharSequence.html">CharSequence</a>
106106
(returned by
107107
<a href="@org-netbeans-modules-lexer@/org/netbeans/api/lexer/Token.html#text--">Token.text()</a>
108108
).
@@ -169,7 +169,7 @@ class with its static methods that provide its instance for the given input sour
169169
Token is identified by its id represented by
170170
<a href="@org-netbeans-modules-lexer@/org/netbeans/api/lexer/TokenId.html">TokenId</a>
171171
interface. Token ids for a language are typically implemented as java enums (extensions of
172-
<a href="@JDK@/java/lang/Enum.html">Enum</a>
172+
<a href="@JDK@@JDKMODULE_JAVA_BASE@/java/lang/Enum.html">Enum</a>
173173
) but it's not mandatory.
174174
<br/>
175175
All token ids for the given language are described by

0 commit comments

Comments
 (0)