RDOC ، Darkfish ، و: call-seq: علامة

Question

أنا بصدد توثيق مشروع Ruby مع RDOC ، واكتشفت تنسيق RDOC Darkfish RDOC. أنا حقا أحب ذلك ، ولكن :call-seq: علامة لم تعد تعمل. بدلاً من ذلك ، يضع السلسلة الحرفية :call-seq: في الوثائق ثم يقوم بتنسيق تسلسل المكالمات نفسه ككتلة رمز. لا أريد فقط أن آخذ كل ما يلي: call-seq: concls من الكود الخاص بي ، لأن الكثير من وثائق بلدي يحتاج إلى الرجوع إلى أسماء المثيلات وأسماء المعلمات الواردة في :call-seq: الكتلة. هل لدى أي شخص آخر هذه المشكلة؟ ماذا علي أن أفعل ، وهل هناك حل؟ أنا متأكد من :call-seq: كانت العلامة تعمل من قبل عندما كنت أستخدم التنسيق الافتراضي ، لكن لا يمكنني التأكد من أنه لا يمكنني معرفة كيفية العودة لإنشاء التنسيق الأصلي (استدعاء RDOC بدون وسيطات باستثناء الملفات التي تنشئها إخراج Darkfish الآن ، حتى لو أحذف مجلد المستند!) هل يعرف أحد كيفية إصلاح هذا؟

Answer 1

أوصي بشدة بالانتقال من RDOC إلى حديقة منزل. لا تدعم المكالمات القديمة نفسها ، ولكن بدلاً من ذلك تحتوي على علامات وخاصة Overload سوف العلامة استبدال بشكل متفوق Call-seq. جميع الوثائق على rubydoc.info ويولد أيضا باستخدام الفناء.

إليك مثال التحميل Overload من وثائق الفناء:

# @overload set(key, value)
#   Sets a value on key
#   @param [Symbol] key describe key param
#   @param [Object] value describe value param
# @overload set(value)
#   Sets a value on the default key `:foo`
#   @param [Object] value describe value param
def set(*args)
end