HADDOCK: Das Abhängigkeitsdiagramm nicht erstellt (beim Hinzufügen von Abschnitten mit * oder einer Modulüberschrift)

Question

Ich habe Haydock-2.4.2 aus der Tarballquelle zusammengestellt und installiert.

Fügen Sie hier ein paar einfache Kommentare zum Code hinzu:

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

und Schellfisch

$ 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

Ausbeuten:

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

Die Dinge sehen gut aus. (Beachten Sie, dass dieses Modul nur von LIBs abhängt, die mit GHC und keinen anderen Quellmodulen versandt werden.)

Wenn ich jedoch versuche, Abschnitte hinzuzufügen (a la http://www.haskell.org/haddock/doc/html/ch03s04.html#id289234 ) In den Kommentaren mit "- * test" bekomme ich:

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

Ich habe keine Ahnung, wo ich anfangen soll, dies zu funktionieren, da diese Fehlermeldung mir nur sagt, dass Haddock.Interface.depanal nichts zurückgegeben hat (laut einem Grep der Hellschadenquellen), aber nicht, wie die Abhängigkeitsanalyse aus fehlgeschlagen ist. Vielleicht brauche ich einige weitere Befehlszeilenargumente oder Verweise auf fehlende Verknüpfungsziele in GHC/Base/Container -Dokumentation oder eine Haddock -Konfigurationsdatei?

Die Suche von Google ergab zahlreiche Kabalen -Build -Fehler derselben Ilk für Pakete auf Hackage, aber nichts, wie man sie behebt.

Wie füge ich Abschnitte (mit Sternchen) hinzu und laufe Haddock, meine Dokumente zu generieren? Was (wahrscheinlich einfach) fehlt mir?

Answer 1

Einfache Fix (schreckliche Fehlermeldung):

Bewegen Sie die (bis zur Linie mit dem Modulnamen. Vorheriger schlechter Code:

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

Happy Code sieht so aus:

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

Einfach genug. Ich habe das durch Download herausgefunden DLIST von Hacakge und auszutauschen und den Code durch meinen eigenen Code zu ersetzen. Als DLIST mit 'Cabal Haddock' arbeitete und meine nicht (als ich versuchte, ein paar Sternchen hinzuzufügen), habe ich mir den Unterschied zwischen den Dateien angesehen und sicher genug, dass meine Klammern in der falschen Zeile war.

Übrigens empfehle ich DLIST als Startplatz für ein neues Haskell -Projekt anstelle von Hnop.