Uploaded image for project: 'Jenkins'
  1. Jenkins
  2. JENKINS-18520

API Documentation Link Broken

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Fixed
    • Icon: Minor Minor
    • php-plugin
    • linux mint

      I have problems with Jenkins PHP project status view. I tried Docblox and phpDocumentor. The link to the documentation is broken (error 404). The documentation has been created. Have a look on the screenshot.

      This is my build.xml (for a zf1 project)

      <?xml version="1.0" encoding="UTF-8"?>
      <!-- Generated by PHP Project Wizard (PPW) 1.0.4 on Mon Jun 17 12:16:48 CEST 2013 -->

      <project name="surveytool" default="build" basedir=".">
      <property name="source" value="application"/>

      <target name="clean" description="Clean up and create artifact directories">
      <delete dir="${basedir}/build/api"/>
      <delete dir="${basedir}/build/code-browser"/>
      <delete dir="${basedir}/build/coverage"/>
      <delete dir="${basedir}/build/logs"/>
      <delete dir="${basedir}/build/pdepend"/>

      <mkdir dir="${basedir}/build/api"/>
      <mkdir dir="${basedir}/build/code-browser"/>
      <mkdir dir="${basedir}/build/coverage"/>
      <mkdir dir="${basedir}/build/logs"/>
      <mkdir dir="${basedir}/build/pdepend"/>
      </target>

      <target name="phpunit" description="Run unit tests using PHPUnit and generates junit.xml and clover.xml">
      <exec executable="phpunit" failonerror="true"/>
      </target>

      <target name="parallelTasks" description="Run the pdepend, phpmd, phpcpd, phpcs, phpdoc and phploc tasks in parallel using a maximum of 2 threads.">
      <parallel threadCount="2">
      <sequential>
      <antcall target="pdepend"/>
      <antcall target="phpmd"/>
      </sequential>
      <antcall target="phpcpd"/>
      <antcall target="phpcs"/>
      <!-<antcall target="phpdoc"/>->
      <antcall target="docblox"/>
      <antcall target="phploc"/>
      </parallel>
      </target>

      <target name="pdepend" description="Generate jdepend.xml and software metrics charts using PHP_Depend">
      <exec executable="pdepend">
      <arg line="--jdepend-xml=${basedir}/build/logs/jdepend.xml
      --jdepend-chart=${basedir}/build/pdepend/dependencies.svg
      --overview-pyramid=${basedir}/build/pdepend/overview-pyramid.svg
      ${source}" />
      </exec>
      </target>

      <target name="phpmd" description="Generate pmd.xml using PHPMD">
      <exec executable="phpmd">
      <arg line="${source}
      xml
      codesize,design,naming,unusedcode
      --reportfile ${basedir}/build/logs/pmd.xml" />
      </exec>
      </target>

      <target name="phpcpd" description="Generate pmd-cpd.xml using PHPCPD">
      <exec executable="phpcpd">
      <arg line="--log-pmd ${basedir}/build/logs/pmd-cpd.xml ${source}" />
      </exec>
      </target>

      <target name="phploc" description="Generate phploc.csv">
      <exec executable="phploc">
      <arg line="--log-csv ${basedir}/build/logs/phploc.csv ${source}" />
      </exec>
      </target>

      <target name="phpcs" description="Generate checkstyle.xml using PHP_CodeSniffer">
      <exec executable="phpcs" output="/dev/null">
      <arg line="--report=checkstyle
      --report-file=${basedir}/build/logs/checkstyle.xml
      --standard=PEAR
      ${source}" />
      </exec>
      </target>
      <!--
      <target name="phpdoc" description="Generate API documentation using PHPDocumentor">
      <exec executable="phpdoc">
      <arg line="-d ${source} -t ${basedir}/build/api" />
      </exec>
      </target>-->

      <target name="docblox" description="Generate API documentation using DocBlox">
      <exec executable="docblox">
      <arg line="project:run -d ${source} -t ${basedir}/build/api" />
      </exec>
      </target>

      <target name="phpcb" description="Aggregate tool output with PHP_CodeBrowser">
      <exec executable="phpcb">
      <arg line="--log ${basedir}/build/logs
      --source ${source}
      --output ${basedir}/build/code-browser" />
      </exec>
      </target>

      <property name="mysqladmin" value="mysqladmin"/>
      <property name="mysql.username" value="root"/>
      <property name="mysql.pwd" value=""/>
      <property name="mysql.dbname" value="oegut-st-testing"/>

      <target name="createDb">
      <exec executable="${mysqladmin}">
      <arg value="--user=${mysql.username}"/>
      <arg value="--password=${mysql.pwd}"/>
      <arg value="CREATE"/>
      <arg value="${mysql.dbname}"/>
      </exec>
      </target>

      <target name="build" depends="clean,createDb,parallelTasks,phpunit,phpcb"/>
      </project>

        1. apidoc.PNG
          29 kB
          Martin Buchmayr

            Unassigned Unassigned
            impf0s Martin Buchmayr
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: