مواصفات تعليقات Doxygen

/****************************************************************************
 *   حقوق النشر (C) 2018 من قبل تعليق C Doxygen                           *
 *                                                                          *
 *   هذا الملف هو جزء من مشروع Box.                                     *
 *                                                                          *
 *   Box هو برنامج مجاني: يمكنك إعادة توزيعه و/أو تعديله بموجب شروط    *
 *   الرخصة العامة الصغرى لجنرال البرمجيات كما نشرتها مؤسسة البرمجيات *
 *   الحرة، إصدار 3 من الرخصة، أو (اختياريا) أي إصدار لاحق.             *
 *                                                                          *
 *   يتم توزيع Box على أمل أن يكون مفيدًا، ولكن بدون أي ضمان؛ حتى بدون *
 *   ضمان ضمني للتسويق أو ملاءمة لغرض معين. انظر للتفاصيل الإضافية    *
 *   في الرخصة العامة الصغرى لجنرال البرمجيات.                           *
 *                                                                          *
 *   يجب أن تكون قد تلقيت نسخة من الرخصة العامة الصغرى لجنرال البرمجيات  *
 *   مع Box. إذا لم يكن الأمر كذلك، راجع <http://www.gnu.org/licenses/>.  *
 ****************************************************************************/

/**
 * @file doxygen_c.h
 * @author someone
 * @date 2018.1.4
 * @brief مستند مواصفات تعليق الملف C بناءً على مواصفات Doxygen،
 * يمكن التبديل إلى السطر التالي
 *
 * @details شرح وتوضيح مفصل لهذا المستند، يمكن التبديل إلى السطر التالي
 */

#include "header.h"

/**
 * @brief ملخص موجز
 *
 * @details توضيح مفصل
 */
typedef enum BoxEnum_enum {
  BOXENUM_FIRST,  /**< بعض التوثيق للأول. */
  BOXENUM_SECOND, /**< بعض التوثيق للثاني. */
  BOXENUM_ETC     /**< وما إلى ذلك. */
} BoxEnum;

/**
 * @brief شرح مختصر للوظيفة، يمكن أن يكون متعدد الأسطر
 *
 * @details شرح مفصل للوظيفة مع شروط وتفاصيل، يمكن أن يكون متعدد الأسطر
 *
 * @note ملاحظات هامة
 *
 * @param index النص الشرحي
 * @param cent النص الشرحي
 *
 * @return وصف للقيمة المُرجَعة من الوظيفة
 * @retval 1 نجاح الاختبار
 * @retval -1 فشل الاختبار
 */
bool Test(int index, char *cent);

int element = 0; /**< شرح مبسّط للمتغير */

/**
 * @brief شرح مختصر للمتغير
 *
 * @details شرح مفصل للمتغير
 */
unsigned int variable = 0;

/**
 * @brief شرح مختصر للماكرو
 *
 * @details شرح مفصل للماكرو
 */
#define variable 10