Programmming language API

Several elements allows to show a link to different a programming language API:

• The javadoc element show a link to a Java class documentation
• The dotnetdoc element show a link to a .NET class documentation
• The qtdoc element show a link to a Qt class documentation
• The pydoc element show a link to a Python module documentation
• The doxygen element show a link to a doxygen class documentation

General attributes

The following attributes are supported for all programmming language APIs:

• "api": the API. It will point to the default API for the language, if not present (and the location is not specified), else it will refer to the API for the language defined in the configuration file
• "location": the direct location of the API (alternative to the "api" attribute)
• "path" : the path to the class
• "inherit": the optional class which will be used to access the API^[1]
  See Usage of inherit for more information
• "altPath": the optional alternate text to present for the path to the API element^[2]
  See Usage of altPath for more information
• "member": the method of the specified class (optional)
• "checkLink": false to not check the validity of the link even if the configuration property specifies that links should be checked^[3]
  See checking external links

Usage of altPath

The "altPath" attribute is an optional alternate text to present for the path to the class. It can be useful if the member is defined for a parent class but you want to show the API for a subclass. It will allow you to present the API on the class you choose and avoid any error emitted because the link is not found in the API.

For example, if you have the following declaration:

   <javadoc path="javax.swing.JButton" member="setLabel(String)"/>

You would have an error, because the setLabel(String) method is defined in the AbstractButton class, and not on its JButton subclass.

But you can declare:

   <javadoc path="javax.swing.AbstractButton" altPath="JButton" member="setLabel(String)"/>

With the following result:
JButton.setLabel(String)

Usage of inherit

The "inherit" attribute is an optional path for a parent class or interface of the class, which will be used to access the member. This is an alternative to using the "altPath" attribute.

For example you can declare:

   <javadoc inherit="javax.swing.AbstractButton" path="javax.swing.JButton" member="setLabel(String)"/>

With the following result:
JButton.setLabel(String)

Examples

   This is a link to <javadoc path="java.awt.Button" />

   This is a link to <dotnetdoc path="System.AppDomain"/>
      
   This is a link to <qtdoc location="http://doc.qt.io/qt-5.12/" path="QAbstractAxis"/>
      
   This is a link to <pydoc module="array" />

Result: This is a link to Button

This is a link to System.AppDomain

This is a link to QAbstractAxis

This is a link to array