Some updates to the apidoc rules

diff --git a/Ganeti/HTools/Cluster.hs b/Ganeti/HTools/Cluster.hs
index c7b7350..c6f8e6c 100644 (file)
--- a/Ganeti/HTools/Cluster.hs
+++ b/Ganeti/HTools/Cluster.hs
@@ -1,7 +1,7 @@
 {-| Implementation of cluster-wide logic.
 
 This module holds all pure cluster-logic; I\/O related functionality
-goes into the "Main" module.
+goes into the "Main" module for the individual binaries.
 
 -}
 
@@ -45,6 +45,7 @@ import Ganeti.HTools.Utils
 
 type NodeList = Container.Container Node.Node
 type InstanceList = Container.Container Instance.Instance
+-- | A separate name for the cluster score type
 type Score = Double
 
 -- | The description of an instance placement.

diff --git a/Ganeti/HTools/Version.hs.in b/Ganeti/HTools/Version.hs.in
index daffa76..8bd4a73 100644 (file)
--- a/Ganeti/HTools/Version.hs.in
+++ b/Ganeti/HTools/Version.hs.in
@@ -1,6 +1,9 @@
+-- Hey Emacs, this is a -*- haskell -*- file
+
 module Ganeti.HTools.Version
     (
-      version -- ^ the version of the tree
+      version
     ) where
 
+-- | The version of the tree
 version = "(htools) version %ver%"

diff --git a/Makefile b/Makefile
index cf7a064..3656ff6 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -24,8 +24,8 @@ doc: $(DOCS)
        done
        haddock --odir $(HDDIR) --html --ignore-all-exports \
                -t htools -p haddock-prologue \
-               --source-module="Ganeti/HTools/%{MODULE/.//}.html" \
-               --source-entity="Ganeti/HTools/%{MODULE/.//}.html#%{NAME}" \
+               --source-module="%{MODULE/.//}.html" \
+               --source-entity="%{MODULE/.//}.html#%{NAME}" \
                $(HSRCS)
 
 clean: