توثيق الوظائف في C ++ مع doxygen [مغلق

Question

لدي مشروع أستخدمه Doxygen لإنشاء وثائق. إن وثائق الفصول جيدة ، لكن لدي أيضًا بعض الوظائف غير الأعضاء التي أستخدمها لإنشاء كائنات وما إلى ذلك. أود أيضًا توثيق هذه الموثق ، ولكن بغض النظر عن ما أحاول ، لن يقوم Doxygen بإنشاء وثائق من التعليقات التي وضعتها فوق الوظائف. لماذا لا تقوم Doxygen بإنشاء وثائق للوظائف في مساحة الاسم العالمية ، وما الذي يجب علي فعله للحصول على هذا العمل؟

Answer 1

يستخدم \fn حيث تستخدم خلاف ذلك \class في الخاص بك \\*! *\ الكتلة

http://www.doxygen.nl/manual/docblocks.htmlابحث عن "الوثائق في أماكن أخرى"

http://www.doxygen.nl/manual/Commands.html#cmdfn
إنه يعمل مماثلة لتوثيق وظائف الأعضاء

Answer 2

يتم توثيق الكيانات التي هي أعضاء في الفصول فقط إذا تم توثيق فصلهم. يتم توثيق الكيانات التي تم الإعلان عنها في نطاق المساحة فقط إذا تم توثيق مساحة الاسم. يتم توثيق الكيانات التي تم الإعلان عنها في نطاق الملف فقط إذا تم توثيق ملفها.

لذا لتوثيق وظيفة مجانية في مساحة الاسم العالمية ، تحتاج أيضًا إلى سطر مثل هذا في مكان ما في ملف الرأس الذي يتم الإعلان عنه:

/** @file */

او مثل هذا:

/*! \file */

Answer 3

هذا النمط عمل بشكل جيد بالنسبة لنا.

/*! Convert counts to kg for the reservoir.  
    \param counts The A/D counts to convert.` 
    \return The calculated kg based on the parameter.  
*/  
float RES_ConvertCountsToValue(uint_16 counts);  

Answer 4

أنا أحب هذا النمط

   ///////////////////////////////////////////////////////////////////////
   /// \brief setX
   /// \param x offset of the image.
   /// \return a new image as an QImage.
   /////////////////////////////////////////////////////////////////////////
    QImage  setX(int x);