Doxygen documentation speeds the programming of CatchTheBus® up
30.10.2013

Doxygen documentation speeds the programming of CatchTheBus® up

CatchTheBus® is being delivered with an excellent documentation that combines the detailed information about each hardware or software element with the DOXYGEN documentation of the API (driver libraries). This post gives an overview on how powerful the DOXYGEN tool is. The complete CatchTheBus® libraries (i.e. the source code) were being documented by using special tags. Those tags enable the DOXYGEN parser to generate a detailed documentation of the source code that will speed up the taking into operation by the user of the libraries. The following snapshot shows the CatchTheBus® documentation. It is embedded in a standard Microsoft Windows help file which raises the user friendliness as it provides enhanced search and navigation functionalities.

doxygen_can_module_view

Click to enlarge

Each source code file, function, data structure, macro, variable, enumerator or define is being documented and
linked
.

For example:
Assuming a user is willing to take the CAN API into operation. He selects the CAN module as shown on the snapshot above and gets directly access to the list of files, functions, data structures,… that are related to the CAN driver. By simply clicking for example on the CAN_Init function he will get to the documentation of this one and see all its parameters as following:

Can_Init function documentation

Can_Init function documentation

He directly has an overview on the “in”, “out” and “inout” parameters as well as on the return value. To know now what parameter value the user can enter in the Can_Init() function, he simply clicks on the variable type of the chosen parameter. For example ECanBitrate:

CAN bitrate enumerator

Possible values for the CAN bitrate parameter

The user can make a copy and paste of the wanted value into his code and initialize the CAN bus number 0 with the following line: Can_Init(CAN_0, CAN_BITRATE_500K); At this point, the CAN experts shall not get disappointed by the simplicity of the call, CatchTheBus® also provides a CAN_InitExt() function letting them tune operation modes, callbacks upon frame reception and other parameters. Another aspect is also speeding up the taking into operation of CatchTheBus®. The libraries were being developed according to a stringent programming standard. Among other, each function, variable, enumerator or define name encapsulate the nature and the membership of the variable (e.g. ECANBitrate: “E” for enumerator, “CAN” for the membership and “Bitrate” as name).

Adding on top all the example applications makes

programming CatchTheBus® become a very easy task!

Have a look at the CatchTheBus® description…

Tags: , ,

Comments are closed.