为 OSGi 包生成 Javadoc

Question

我是 OSGi 世界的新手，但我能够使用一些 Camel 和 OSGi 包在中间件中完成一些任务。从那以后我所做的一切都是概念证明，但现在我想重构我的代码的某些部分，我开始编写一个 OSGi 包，它将包含在其他 OSGi 包中共享的通用功能。

为了让它更干净，我决定写评论并使用 javadoc 来获得流畅的文档，但我遇到了这个错误：

Error resolving version for plugin 
'org.apache.maven.plugins:maven-javadoc-plugin' from the repositories

我能够运行另一个 Camel 组件的 javadoc；

我们有一个本地存储库，其中包含依赖项 maven-javadoc-plugin；

我将依赖项 maven-javadoc-plugin 添加到我的项目中；

我运行不知道为什么它不起作用。

也许我错了，我以错误的方式使用 OSGi 包...

更新

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>

<groupId>org</groupId>
<artifactId>test</artifactId>
<version>0.0.1</version>
<packaging>bundle</packaging>

<name>uces OSGi Bundle</name>

<dependencies>
    <dependency>
        <groupId>org.osgi</groupId>
        <artifactId>org.osgi.core</artifactId>
        <version>4.3.0</version>
        <scope>provided</scope>
    </dependency>
    <dependency>
        <groupId>com.thoughtworks.xstream</groupId>
        <artifactId>xstream</artifactId>
        <version>1.4.8</version>
    </dependency>
    <dependency>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <version>2.10.3</version>
    </dependency>
</dependencies>

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.felix</groupId>
            <artifactId>maven-bundle-plugin</artifactId>
            <version>2.3.7</version>
            <extensions>true</extensions>
            <configuration>
                <instructions>
                    <Bundle-Activator>org.test.Activator</Bundle-Activator>
                    <Export-Package>org.test</Export-Package>
                </instructions>
            </configuration>
        </plugin>
    </plugins>
</build>

<profiles>
    <profile>
        <id>build-for-felix</id>
        <dependencies>
            <dependency>
                <groupId>org.apache.felix</groupId>
                <artifactId>org.apache.felix.main</artifactId>
                <version>4.0.3</version>
                <scope>provided</scope>
            </dependency>
            <!-- To include a shell:
            <dependency>
                <groupId>org.apache.felix</groupId>
                <artifactId>org.apache.felix.gogo.shell</artifactId>
                <version>0.10.0</version>
            </dependency>
            -->
        </dependencies>
        <build>
            <plugins>
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-antrun-plugin</artifactId>
                    <version>1.7</version>
                    <executions>
                        <execution>
                            <id>compile</id>
                            <phase>package</phase>
                            <goals>
                                <goal>run</goal>
                            </goals>
                            <configuration>
                                <target>
                                    <pathconvert property="plugins.jars" pathsep="${path.separator}">
                                        <path refid="maven.runtime.classpath"/>
                                        <map from="${project.build.directory}${file.separator}classes" to=""/>
                                    </pathconvert>
                                    <pathconvert pathsep=" " property="bundles">
                                        <path path="${plugins.jars}"/>
                                        <mapper>
                                            <chainedmapper>
                                                <flattenmapper/>
                                                <globmapper from="*" to="file:modules/*" casesensitive="no"/>
                                            </chainedmapper>
                                        </mapper>
                                    </pathconvert>
                                    <propertyfile file="${project.build.directory}/config.properties">
                                        <entry key="felix.auto.start" value="${bundles} file:modules/${project.build.finalName}.jar"/>
                                        <entry key="org.osgi.framework.bootdelegation" value="*"/>
                                    </propertyfile>
                                    <copy file="${maven.dependency.org.apache.felix.org.apache.felix.main.jar.path}" tofile="${project.build.directory}/felix.jar"/>
                                </target>
                            </configuration>
                        </execution>
                    </executions>
                </plugin>
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-assembly-plugin</artifactId>
                    <version>2.3</version>
                    <executions>
                        <execution>
                            <id>create-executable-jar</id>
                            <phase>package</phase>
                            <goals>
                                <goal>single</goal>
                            </goals>
                            <configuration>
                                <descriptors>
                                    <descriptor>${basedir}/src/main/assembly/felix.xml</descriptor>
                                </descriptors>
                                <finalName>${project.build.finalName}</finalName>
                            </configuration>
                        </execution>
                    </executions>
                </plugin>
            </plugins>
        </build>
    </profile>
    <profile>
        <id>run-on-felix</id>
        <dependencies>
            <dependency>
                <groupId>org.apache.felix</groupId>
                <artifactId>org.apache.felix.main</artifactId>
                <version>4.0.3</version>
                <scope>provided</scope>
            </dependency>
            <!-- org.apache.felix:org.apache.felix.gogo.shell:0.6.1 useless from Maven since stdin is swallowed -->
        </dependencies>
        <build>
            <plugins>
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-antrun-plugin</artifactId>
                    <version>1.7</version>
                    <configuration>
                        <target>
                            <property name="vm.args" value=""/>
                            <pathconvert property="plugins.jars" pathsep="${path.separator}">
                                <path refid="maven.runtime.classpath"/>
                                <map from="${project.build.directory}${file.separator}classes" to=""/>
                            </pathconvert>
                            <makeurl property="urls" separator=" ">
                                <path path="${plugins.jars}"/>
                                <path location="${project.build.directory}/${project.build.finalName}.jar"/>
                            </makeurl>
                            <propertyfile file="${project.build.directory}/run.properties">
                                <entry key="felix.auto.start" value="${urls}"/>
                                <entry key="felix.auto.deploy.action" value="uninstall,install,update,start"/>
                                <entry key="org.osgi.framework.storage" value="${project.build.directory}${file.separator}felix-cache"/>
                                <entry key="org.osgi.framework.bootdelegation" value="*"/>
                            </propertyfile>
                            <makeurl property="run.properties.url" file="${project.build.directory}/run.properties"/>
                            <java fork="true" jar="${maven.dependency.org.apache.felix.org.apache.felix.main.jar.path}">
                                <sysproperty key="felix.config.properties" value="${run.properties.url}"/>
                                <jvmarg line="${vm.args}"/>
                            </java>
                        </target>
                    </configuration>
                </plugin>
            </plugins>
        </build>
    </profile>
</profiles>

Answer 1

好的，在深入挖掘 javadoc 页面 (Javadoc documentation) 并将这些行添加到构建部分后，我终于找到了我的回应：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>2.10.3</version>
</plugin>

为 OSGi 包生成 Javadoc

Generate Javadoc for OSGi bundle

javadoc

apache-camel

maven-javadoc-plugin

osgi-bundle

apache-servicemix