Haddock: فشل في إنشاء رسم بياني التبعية (عند إضافة أقسام * أو عنوان وحدة)

Question

قمت بتجميع وتثبيت Haddock-2.4.2 من مصدر Tarball.

إضافة بعض التعليقات البسيطة إلى الكود هنا:

• https://dl.getdropbox.com/u/143480/doc/dualmap.hs.

وتشغيل الحدوق

$ haddock -h -o doc Data/DualMap.hs
Warning: Data.DualMap: could not find link destinations for:
    Data.Typeable.Typeable2 GHC.Base.Eq GHC.Show.Show GHC.Base.Ord GHC.Base.Bool Data.Set.Set

عائدات:

• https://dl.getdropbox.com/u/143480/doc/data-dualmap.html.

الأشياء تبدو جيدة. (لاحظ أن هذه الوحدة تعتمد فقط على Libs التي تشحن مع GHC ولا توجد وحدات مصدر أخرى.)

ومع ذلك، عندما أحاول إضافة أقسام (A LA http://www.haskell.org/haddock/doc/html/ch03s04.htmlbls289234. ) في التعليقات مع "- * اختبار" أحصل عليه:

$ haddock -h -o doc Data/DualMap.hs
Data/DualMap.hs:20:0: parse error on input `-- * test'
haddock: Failed to create dependency graph

ليس لدي أي فكرة عن مكان البدء في الحصول على هذا للعمل لأن رسالة الخطأ هذه تخبرني فقط أن Haddock.Interface.depanal عاد لا شيء (وفقا ل GREP من مصادر Haddock) ولكن ليس كيفية إيقاف تحليل التبعية من الفشل. ربما أحتاج إلى بعض حجج أو إشارات أكثر لوجهات الرابط المفقودة في وثائق GHC / Base / Contanters أو بعض ملف تكوين Haddock؟

أسفرت Google عن الكثير من أخطاء Build Cabal من نفس ILK للحصول على حزم على القلعة ولكن لا شيء عن كيفية إصلاحها.

كيف أضيف أقسام (مع العلامات النجمية) والحصول على Haddock لتوليد مستنداتي؟ ما (ربما شيء بسيط) أنا في عداد المفقودين؟

Answer 1

إصلاح بسيط (رسالة خطأ فظيعة):

حرك (ما يصل إلى الخط باستخدام اسم الوحدة النمطية. رمز سيء سابق:

module Data.DualMap
   -- * The @DualMap@ abstract type
   ( DualMap ()
   -- * (?) internal? -- exposed for testing purposes, for now...
   , dmFlip
   -- * converting to and from DualMap
   , toList, fromList, map
   -- * constructing a DualMap
   , empty, null, insert, union

رمز سعيد يشبه هذا:

module Data.DualMap (
   -- * The @DualMap@ abstract type                                                                                                                                 
     DualMap ()
   -- * (?) internal? -- exposed for testing purposes, for now...                                                                                                   
   , dmFlip
   -- * converting to and from DualMap                                                                                                                              
   , toList, fromList, map
   -- * constructing a DualMap                                                                                                                                      
   , empty, null, insert, union

بسيطا بما فيه الكفاية. لقد وجدت هذا من خلال التنزيل distrom من hacakge. وتتعلقها واستبدال الرمز برمزي الخاص. عندما عملت DAST LAST مع "Cabal Haddock"، لم يكن لي (عندما حاولت إضافة بعض العلامات النجمية)، نظرت إلى الفرق بين الملفات وبالتأكيد كان ما يكفي من قوساتي على الخط الخطأ.

راجع للشغل أنا أوصي بشدة distase كمركز بداية لمشروع Haskell جديد بدلا من HNOP..