• State
  • Locked Locked
  • Replies 4 replies
  • Subscribers 82 subscribers
  • Views 856 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.

Doxygen Documentation

Timon Achtnich
Intellectual 555 points
Other Parts Discussed in Thread: MOTORWARE

Hi,

I am using some modules and drivers of the motorware library. The source code is nicely documented with doxygen. I would like to recompile the doxygen comments of some modules and drivers.

However, the doxygen overview of some files is not given. For example in the park module there is given a link to another file:

// Include the algorithm overview defined in modules/<module>/docs/doxygen/doxygen.h

//!\defgroup PARK_OVERVIEW

 

The given path is not valid in the current motorware edition (1_01_00_08). Could you please give me a detailed explanation how to generate the html doxygen documentation with the include of the mentioned overview part?

 

Regards,

 

Timon

  • 0
    TI__Guru** 119670 points

    Timon,

    Are you viewing the content through MotorWare.exe?  I get the feeling that you aren't.  In MotorWare.exe we have already pulled in all the doxygen content and categorize it and let you browse it quite easily.

    The actual source for this content remains in our repository, and when we make a release the doxygen scripts run and create the html files which are stored at

    sw\modules\docs\api\f2806x\html

    sw\drivers\docs\api\f2806x\html

    and for each board+mcu set of projects, ex:

    sw\solutions\instaspin_foc\boards\drv8301kit_revD\f28x\f2806xF\docs\html

    and then MotorWare.exe organizes and displays this html content.

    Make sense?

     

     

  • 0 in reply to ChrisClearman
    Intellectual 555 points

    Hi Chris,

    Thank for your answer. You are right, in motorware the documentation is nicely displayed, except the formulas are not visible. I see that for example in the module PID, there the formulas are not shown.

    However, I am using some drivers in another project (The drivers of the motorware project are organized in an object oriented way, which is very good for encapsulating. Therefore I want to reuse them). In my project I want to rebuildt the documentation and therefore, I need these doxygen files for the overview. Would it be possible that you provide me these files for the documentation?

    Regards,

    Timon

  • 0 in reply to Timon Achtnich
    TI__Guru** 119670 points

    Timon,

    I'm seeing what I can do to help you out. I'd need to pull all the source from our repo and will also have to get a legal license agreement. Let me see...

  • 0 in reply to ChrisClearman
    TI__Guru** 119670 points

    Timon,

    why don't you message me your email and I'll send you a zip with the doxygen source to the drivers and modules, will that be good enough?