Skip to content

Commit

Permalink
Fail on javadoc errors
Browse files Browse the repository at this point in the history
And fix failures so the build doesn't fail. Skipping org.eclipse.osgi as
it is too complicated and will delay getting rest of Equinox javadoc
being validated.
  • Loading branch information
akurtakov committed Dec 12, 2024
1 parent abda584 commit ca520e4
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 15 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -26,14 +26,12 @@
/**
* The registry strategy used by the Equinox extension registry. Adds to the
* OSGi registry:
* <p>
* <ul>
* <li>Use debug information supplied via .options files</li>
* <li>Use Eclipse logging - Use Eclipse platform state for cache
* validation</li>
* <li>Event scheduling is done using Eclipse job scheduling mechanism</li>
* </ul>
* </p>
*
* @since org.eclipse.equinox.registry 3.2
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@
/**
* The registry strategy that can be used in OSGi world. It provides the
* following functionality:
* <p>
* <ul>
* <li>Translation is done with ResourceTranslator</li>
* <li>Registry is filled with information stored in plugin.xml / fragment.xml
Expand All @@ -44,8 +43,7 @@
* fragment.xml files</li>
* <li>XML parser is obtained via an OSGi service</li>
* </ul>
* </p>
*
*
* @see RegistryFactory#setDefaultRegistryProvider(IRegistryProvider)
* @since org.eclipse.equinox.registry 3.2
*/
Expand Down Expand Up @@ -108,7 +106,7 @@ public RegistryStrategyOSGI(File[] theStorageDir, boolean[] cacheReadOnly, Objec

/*
* (non-Javadoc)
*
*
* @see
* org.eclipse.core.runtime.spi.RegistryStrategy#translate(java.lang.String,
* java.util.ResourceBundle)
Expand All @@ -120,7 +118,7 @@ public final String translate(String key, ResourceBundle resources) {

/*
* (non-Javadoc)
*
*
* @see
* org.eclipse.core.runtime.spi.RegistryStrategy#translate(java.lang.String[],
* org.eclipse.core.runtime.IContributor, java.lang.String)
Expand Down Expand Up @@ -198,7 +196,7 @@ private Bundle getBundle(String id) {

/*
* (non-Javadoc)
*
*
* @see
* org.eclipse.core.runtime.spi.RegistryStrategy#createExecutableExtension(org.
* eclipse.core.runtime.spi.RegistryContributor, java.lang.String,
Expand Down Expand Up @@ -256,7 +254,7 @@ private void throwException(String message, Throwable exception) throws CoreExce

/*
* (non-Javadoc)
*
*
* @see org.eclipse.core.runtime.spi.RegistryStrategy#onStart(org.eclipse.core.
* runtime.IExtensionRegistry, boolean)
*/
Expand All @@ -282,7 +280,7 @@ public void onStart(IExtensionRegistry registry, boolean loadedFromCache) {

/*
* (non-Javadoc)
*
*
* @see
* org.eclipse.core.runtime.spi.RegistryStrategy#onStop(org.eclipse.core.runtime
* .IExtensionRegistry)
Expand All @@ -307,7 +305,7 @@ public void onStop(IExtensionRegistry registry) {

/*
* (non-Javadoc)
*
*
* @see org.eclipse.core.runtime.spi.RegistryStrategy#cacheUse()
*/
@Override
Expand All @@ -317,7 +315,7 @@ public boolean cacheUse() {

/*
* (non-Javadoc)
*
*
* @see org.eclipse.core.runtime.spi.RegistryStrategy#cacheLazyLoading()
*/
@Override
Expand All @@ -328,7 +326,7 @@ public boolean cacheLazyLoading() {

/*
* (non-Javadoc)
*
*
* @see
* org.eclipse.core.runtime.spi.RegistryStrategy#getContributionsTimestamp()
*/
Expand Down Expand Up @@ -369,7 +367,7 @@ public long getExtendedTimestamp(Bundle bundle, URL pluginManifest) {

/*
* (non-Javadoc)
*
*
* @see org.eclipse.core.runtime.spi.RegistryStrategy#getXMLParser()
*/
@Override
Expand All @@ -383,7 +381,7 @@ public SAXParserFactory getXMLParser() {

/*
* (non-Javadoc)
*
*
* @see org.eclipse.core.runtime.spi.RegistryStrategy#getLocale()
*/
@Override
Expand Down
1 change: 1 addition & 0 deletions bundles/org.eclipse.osgi/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
<properties>
<!-- The actual TCKs are executed in the org.eclipse.osgi.tck module because of reference to other service implementations -->
<tck.skip>true</tck.skip>
<failOnJavadocErrors>false</failOnJavadocErrors>
</properties>

<build>
Expand Down
1 change: 1 addition & 0 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
<!-- required by: org.eclipse.equinox.framework:launcher-binary-parent -->
<equinox.binaries.loc>../../../equinox.binaries</equinox.binaries.loc>
<target-platform.optionalDependencies>require</target-platform.optionalDependencies>
<failOnJavadocErrors>true</failOnJavadocErrors>
</properties>

<!--
Expand Down

0 comments on commit ca520e4

Please sign in to comment.