APIs property

The APIs property in the configuration file allows to configure the access to external APIs and wikis.

APIs property

The "APIs" property in the configuration file specifes an XML file defining a list of APIs and wikis. See APIs.xsd for the the associated Schema. Thei file allows to specify a list of APIs and Mediawikis, and for each API or wikis:

• Its URL
• Its ID
• Optionally, for Javadocs APIs, a list of local libraries (Jar files) which represent this API. These Jar files will be used to validate the javadoc tags for the corresponding API if the API URL is an http link and the "checkHTTPLinks" property is set to false

Grammar

See The APIs Schema.

APIs syntax elements

The following elements in the articles will point to APIs:

• javadoc will point to a javadoc documentation
• pydoc will point to a Python documentation
• qtdoc will point to a Qt documentation
• doxygen will point to a doxygen documentation
• wiki will point to a Mediawiki wiki^[1]
  For wikis, the URL must point to the "final" URL before the articles themselves. For example, for the English wikipedia, it would be "http://en.wikipedia.org/wiki"
  ^[2]
  Note that it is not necessary to define an API link for wikipedia, the wikipedia element in article allows to refer directly to Wikipedia articles without having to define the path of Wikipedia itself in the APis configuration file

Example

  <APIs>
    <javaAPIs>
      <javaAPI url="http://junit.sourceforge.net/javadoc" id="junit">
        <javaAPILibrary jarFile="../junit5.jar" />
      </javaAPI>
    </javaAPIs>
    <qtAPIs>
      <qtAPI url="http://qt.apidoc.info/4.6.4/" id="qt4.6.4" />
    </qtAPIs>
    <mediawikis>
      <mediawiki url="https://en.wikipedia.org/wiki" id="wikipediaEN" />
    </mediawikis>        
  </APIs>