• State Resolved
  • Locked Locked
  • Replies 1 reply
  • Subscribers 53 subscribers
  • Views 446 views
  • Users 0 members are here
Support feedback
Options
Options
Related

This thread has been locked.

If you have a related question, please click the "Ask a related question" button in the top right corner. The newly created question will be automatically linked to this question.

Documenting functions, global variables and parameters in CCS 5.2

John Osen
Genius 3585 points

The group I am working with is about to embark on standardizing function header comments and the like. 

I have wandered around StellarisWare code and have noted some function headers imply some type of documentation tool.  If so, this may influence how we define our function headers.

Are there standard code documentation tools for CCS?  If so, what are the favored tools in TI?

How about code analysis tools that would give ESLOC per module, function and possibly complexity metrics?

I have looked on the Eclipse site, but I have no idea how CCS 5.2 relates to the various flavors of Eclipse.

  • 0
    TI__Guru**** 171809 points

    Hi,

    John Osen said:

    Are there standard code documentation tools for CCS?  If so, what are the favored tools in TI?

    There is no standard documentation tool for CCS, as it is based in Eclipse and therefore any third party plug-in can be used  (a reference article with several productivity tools is here). The same is true to TI, where the tool of choice varies from group to group. As an example, I think that Doxygen is still the tool of choice in the XDC/IPC/BIOS products.

    John Osen said:

    How about code analysis tools that would give ESLOC per module, function and possibly complexity metrics?

     

    There is a code analysis tool embedded into Eclipse, but it is limited to static syntax analysis and does not perform the much more complex tasks you mention above. For that you can check some third party tools that have Eclipse integration (I recall SmartBear, for example). I can't recall any opensource tools that perform this task.

    John Osen said:

    I have looked on the Eclipse site, but I have no idea how CCS 5.2 relates to the various flavors of Eclipse.

    CCSv5.2 is basically Eclipse CDT 3.7 with TI's plug-ins, but designed in a way to not break any compatibility with existing plug-ins. Therefore, if you can find a plug-in that suits your needs and is designed to be used with the same version of the CDT, chances are very high it will work - there is no way to guarantee 100% as the variety and quality of the plugins available varies greatly.

     Regards,

    Rafael