HeaderDoc

الموسوعة الحرة

HeaderDoc هو مولد توثيق طوّرته شركة Apple Inc. وتُديره . يستخدم HeaderDoc ملفات شفرة مصدرية مُعلّقة بشكل خاص كمدخلات، ويُنشئ توثيقًا للشفرة بصيغة HTML أو XML . تتشابه صيغة وسوم التعليقات في HeaderDoc إلى حد كبير مع وسوم Javadoc ، وتدعمها بدءًا من الإصدار 8. كما يُوفر HeaderDoc 8.7 والإصدارات الأحدث دعمًا جزئيًا للعديد من وسوم Doxygen (بصيغة @ فقط، ويجب أن تتوافق مع قواعد ترتيب الوسوم في HeaderDoc). مشروع HeaderDoc من Apple هو برنامج مجاني ومفتوح المصدر ، يُوزّع بموجب ترخيص Apple العام للمصادر .

اللغات النصية العادية المدعومة

تتألف مجموعة أدوات HeaderDoc من الأداة الرئيسية، وأداة headerdoc2html، وأداة gatherheaderdoc. تُنشئ أداة headerdoc2html مجلدًا يحتوي على ملفات HTML (أو XML اختياريًا ) من ملفات المصدر المُعلّقة المُحددة. بعد ذلك، يُمكن تشغيل أداة gatherheaderdoc لإنشاء ملف جدول محتويات للوثائق. أخيرًا، يُمكن استخدام أداة resolveLinks لحلّ الروابط المرجعية بين مجموعات الوثائق المتعددة.

تحتوي بيئة تطوير Xcode من Apple على ميزات مصممة للمساعدة في عملية إنشاء الوثائق باستخدام صيغة وأدوات HeaderDoc.

ميزات إضافية

يحتوي HeaderDoc على الميزات الأساسية التالية:

  • معالجة مسبقة بلغة C، مما يسمح لوحدات الماكرو #define التي يحددها المستخدم بتغيير المحتوى، والسماح للمستخدم بتمرير علامات سطر الأوامر لتجاهل أجزاء من المدخلات.
  • تلوين بناء الجملة باستخدام أنماط يحددها المستخدم.
  • صفحات هبوط مصممة باستخدام قوالب جاهزة للفهارس.
  • متعدد المنصات (مكتوب في الغالب بلغة بيرل).

تتضمن مجموعة HeaderDoc أيضًا العديد من الأدوات التي يمكن استخدامها بشكل مستقل:

  • MPGL — مجموعة من الأدوات المصممة لتبسيط إنشاء صفحات دليل UNIX باستخدام بنية XML خفيفة الوزن تتكون من مجموعة فرعية من XHTML بالإضافة إلى علامات القسم وعلامات المعلمات وما إلى ذلك. يوفر HeaderDoc أيضًا أداة ربط تساعد في إنشاء صفحات الدليل من تعليقات الرأس للوظائف عبر وضع إخراج XML الخاص بـ HeaderDoc.
  • resolveLinks — أداة تسمح بإعادة ربط مواقع الويب بسرعة عندما ينتقل المحتوى إلى عنوان مختلف من خلال استخدام الروابط المضمنة وطلبات الروابط.
  • filtermacros.pl — أداة تُستخدم لتصفية أجزاء من الترويسات بناءً على وحدات ماكرو مُعالج C المُسبقة. هذه الأداة متاحة حاليًا فقط عن طريق تنزيل ملف المصدر المضغوط. بدءًا من HeaderDoc 8.9، أصبحت هذه الوظيفة مُدمجة في أداة headerdoc2html نفسها.

انظر أيضاً