Skip to content

Fixed javadoc code fragments style and tags #1 #5603

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
tbw777 wants to merge 1 commit into from
Closed

Fixed javadoc code fragments style and tags #1 #5603

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions ide/editor.fold/src/org/netbeans/api/editor/fold/FoldingSupport.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,12 @@ private FoldingSupport() {}
* starts with a String, which is stored under 'tokenId' key in the params map.
* <p/>
* The method is designed to be called from the filesystem layer as follows:
* <code><pre>
* &lt;file name="my-custom-foldmanager.instance">
* &lt;attr name="instanceCreate" methodvalue="org.netbeans.api.editor.fold.FoldUtilities.createUserFoldManager"/>
* &lt;attr name="tokenid" stringvalue="comment"/>
* &lt;/file>
* </pre></code>
* <pre>{@code
* <file name="my-custom-foldmanager.instance">
* <attr name="instanceCreate" methodvalue="org.netbeans.api.editor.fold.FoldUtilities.createUserFoldManager"/>
* <attr name="tokenid" stringvalue="comment"/>
* </file>
* }</pre>
*
* @param map the configuration parameters.
* @return FoldManagerFactory instance
Expand Down
26 changes: 13 additions & 13 deletions platform/openide.filesystems/src/org/openide/filesystems/annotations/package-info.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,19 +104,19 @@ public class FrobnitzFactoryProcessor extends LayerGeneratingProcessor {
* </pre>
* <p>Now when the module is compiled, {@code build/classes/META-INF/generated-layer.xml}
* should look something like this:</p>
* <pre>
&lt;filesystem>
&lt;folder name="FrobnitzFactories">
&lt;folder name="text">
&lt;folder name="html">
&lt;file name="my-module-HtmlFactory.instance">
&lt;attr name="position" intvalue="300"/>
&lt;/file>
&lt;/folder>
&lt;/folder>
&lt;/folder>
&lt;/filesystem>
* </pre>
* <pre>{@code
<filesystem>
<folder name="FrobnitzFactories">
<folder name="text">
<folder name="html">
<file name="my-module-HtmlFactory.instance">
<attr name="position" intvalue="300"/>
</file>
</folder>
</folder>
</folder>
</filesystem>
* }</pre>
* <p>and this layer should be loaded automatically by the module system
* (in addition to any explicit layer specified in source code).</p>
* <p>There are two basic ways to test a layer-generating processor:</p>
Expand Down
30 changes: 15 additions & 15 deletions platform/settings/src/org/netbeans/modules/settings/Env.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,42 +36,42 @@
*/
public final class Env implements Environment.Provider {
/** file attribute containing convertor object. Usage
* <code>&lt;attr name="settings.convertor" methodvalue="org.netbeans.modules.settings.XMLPropertiesConvertor.create"/>
* </code>
* <pre>{@code <attr name="settings.convertor" methodvalue="org.netbeans.modules.settings.XMLPropertiesConvertor.create"/>
* }</pre>
*/
public static final String EA_CONVERTOR = "settings.convertor"; //NOI18N
/** file attribute containing path to the provider. Used by
* InstanceDataObject.create or upgrade algorithm. Usage
* <code>&lt;attr name="settings.providerPath" stringvalue="xml/lookups/NetBeans/DTD_XML_Properties_1_0.instance"/>
* </code>
* <pre>{@code <attr name="settings.providerPath" stringvalue="xml/lookups/NetBeans/DTD_XML_Properties_1_0.instance"/>
* }</pre>
*/
public static final String EA_PROVIDER_PATH = "settings.providerPath"; // NOI18N
/** file attribute containing PUBLIC attribute of xml header. Usage
* <code>&lt;attr name="hint.originalPublicID" stringvalue="-//NetBeans//DTD XML Properties 1.0//EN"/>
* </code>
* <pre>{@code <attr name="hint.originalPublicID" stringvalue="-//NetBeans//DTD XML Properties 1.0//EN"/>
* }</pre>
*/
public static final String EA_PUBLICID = "hint.originalPublicID"; // NOI18N
/** file attribute containnig class name of the setting object. Usage
* <code>&lt;attr name="settings.instanceClass" stringvalue="org.netbeans.modules.foo.Foo"/>
* </code>
* <pre>{@code <attr name="settings.instanceClass" stringvalue="org.netbeans.modules.foo.Foo"/>
* }</pre>
*/
public static final String EA_INSTANCE_CLASS_NAME = "settings.instanceClass"; //NOI18N
/** file attribute containnig class name and subclass names of the setting object. Use the
* attribute for performance reasons. Usage
* <code>&lt;attr name="settings.instanceOf" stringvalue="org.netbeans.modules.foo.Foo[, ...]"/>
* </code>
* <pre>{@code <attr name="settings.instanceOf" stringvalue="org.netbeans.modules.foo.Foo[, ...]"/>
* }</pre>
*/
public static final String EA_INSTANCE_OF = "settings.instanceOf"; //NOI18N
/** file attribute containnig the setting object. Usage
* <code>&lt;attr name="settings.instanceCreate" newvalue="org.netbeans.modules.foo.Foo"/>
* </code> or
* <code>&lt;attr name="settings.instanceCreate" methodvalue="org.netbeans.modules.foo.Foo.create"/>
* </code>
* <pre>{@code <attr name="settings.instanceCreate" newvalue="org.netbeans.modules.foo.Foo"/>
* }</pre> or
* <pre>{@code <attr name="settings.instanceCreate" methodvalue="org.netbeans.modules.foo.Foo.create"/>
* }</pre>
*/
public static final String EA_INSTANCE_CREATE = "settings.instanceCreate"; //NOI18N
/** file attribute determining whether the registration works also for subclasses of the registering
* class. Use of this attribute is optional. The default is false, the value must be boolean, example:
* <code>&lt;attr name="settings.subclasses" boolvalue="true"/&gt;</code>
* <pre>{@code <attr name="settings.subclasses" boolvalue="true"/>}</pre>
*/
public static final String EA_SUBCLASSES = "settings.subclasses"; // NOI18N

Expand Down
10 changes: 5 additions & 5 deletions platform/settings/src/org/netbeans/modules/settings/convertors/XMLPropertiesConvertor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,14 +45,14 @@
public final class XMLPropertiesConvertor extends Convertor implements PropertyChangeListener {
/** file attribute containnig value whether the setting object will be
* stored automaticaly (preventStoring==false) or SaveCookie will be provided.
* Default value is <code>preventStoring==false</code>. Usage
* <code>&lt;attr name="xmlproperties.preventStoring" boolvalue="[true|false]"/>
* </code>
* Default value is <pre>{@code preventStoring==false}</pre>. Usage
* <pre>{@code <attr name="xmlproperties.preventStoring" boolvalue="[true|false]"/>
* }</pre>
*/
public static final String EA_PREVENT_STORING = "xmlproperties.preventStoring"; //NOI18N
/** file attribute containnig list of property names their changes will be ignored. Usage
* <code>&lt;attr name="xmlproperties.ignoreChanges" stringvalue="name[, ...]"/>
* </code>
* <pre>{@code <attr name="xmlproperties.ignoreChanges" stringvalue="name[, ...]"/>
* }</pre>
*/
public static final String EA_IGNORE_CHANGES = "xmlproperties.ignoreChanges"; //NOI18N
private FileObject providerFO;
Expand Down
30 changes: 15 additions & 15 deletions platform/spi.quicksearch/src/org/netbeans/spi/quicksearch/SearchProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,21 +28,21 @@
* providers, implementations of SearchProvider must be registered through xml
* layer in following way:
*
* <pre>
* &lt;folder name="QuickSearch"&gt;
* &lt;folder name="MyCategoryID"&gt;
* &lt;!--Attribute for localization - provide localized display name of category!--&gt;
* &lt;attr name="SystemFileSystem.localizingBundle" stringvalue="org.netbeans.modules.yourmodule.YourBundle"/>
* &lt;!--Attribute for command prefix - used to narrow search to this category only!--&gt;
* &lt;attr name="command" stringvalue="p"/>
* &lt;!--Attribute for category ordering!--&gt;
* &lt;attr name="position" intvalue="200"/&gt;
* &lt;!--Note that multiple providers can contribute to one category!--&gt;
* &lt;file name="org-netbeans-module2-package2-MySearchProviderImpll.instance"/&gt;
* &lt;file name="org-netbeans-module2-package3-MySearchProviderImpl2.instance"/&gt;
* &lt;/folder&gt;
* &lt;/folder&gt;
* </pre>
* <pre>{@code
* <folder name="QuickSearch">
* <folder name="MyCategoryID">
* <!--Attribute for localization - provide localized display name of category!-->
* <attr name="SystemFileSystem.localizingBundle" stringvalue="org.netbeans.modules.yourmodule.YourBundle"/>
* <!--Attribute for command prefix - used to narrow search to this category only!-->
* <attr name="command" stringvalue="p"/>
* <!--Attribute for category ordering!-->
* <attr name="position" intvalue="200"/>
* <!--Note that multiple providers can contribute to one category!-->
* <file name="org-netbeans-module2-package2-MySearchProviderImpll.instance"/>
* <file name="org-netbeans-module2-package3-MySearchProviderImpl2.instance"/>
* </folder>
* </folder>
* }</pre>
*
* @author Jan Becicka, Dafe Simonek
*/
Expand Down