Added documentation for vecEquiv and alias.

Author: svenpanne

CHANGELOG.md

@@ -1,3 +1,10 @@
+2.5.5.0
+-------
+* Added retrieval of version info and extensions.
+* Added extension predicates.
+* Added documentation for vector equivalents and aliases.
+* Consistently use UTF-8 as the encoding.
+
 2.5.4.0
 -------
 * Added documentation for enumerant groups.

RegistryProcessor/src/Main.hs

@@ -552,7 +552,7 @@ showCommand :: API -> Registry -> M.Map String String -> Command -> String
 showCommand api registry sigMap c =
   showString (take 80 ("-- " ++ name ++ " " ++ repeat '-') ++ "\n\n") .
 
-  showString man .
+  showString comment .
 
   showString (name ++ "\n") .
   showString ("  :: MonadIO m\n") .
@@ -572,11 +572,16 @@ showCommand api registry sigMap c =
         compactSignature = signature False
         signature withComment = showSignatureFromCommand registry c withComment
         urls = M.findWithDefault [] (api, CommandName name) manPageURLs
-        links = L.intercalate " or " (map renderURL urls)  ++ "\n"
+        links = L.intercalate " or " (map renderURL urls)
+        comment = case concat (man ++ ve ++ al) of
+                    ""  -> ""
+                    cs -> "-- |" ++ cs ++ "\n"
         man = case urls of
-                []  -> ""
-                [_] ->  "-- | Manual page for "  ++ links
-                _   ->  "-- | Manual pages for " ++ links
+                []  -> []
+                [_] -> [" Manual page for "  ++ links ++ "."]
+                _   -> [" Manual pages for " ++ links ++ "."]
+        ve = [ " The vector equivalent of this command is '" ++ unCommandName v ++ "'." | Just v <- [vecEquiv c] ]
+        al = [ " This command is an alias for '" ++ unCommandName a ++ "'." | Just a <- [alias c] ]
         renderURL (u, l) = "<" ++ u ++ " " ++ l ++ ">"
         args = [1 .. length (paramTypes c)] >>= \i -> " v" ++ show i
 

RegistryProcessor/src/MangledRegistry.hs

@@ -149,7 +149,9 @@ joinWords = L.intercalate [splitChar]
 data Command = Command {
   resultType :: SignatureElement,
   paramTypes :: [SignatureElement],
-  referencedTypes :: S.Set R.TypeName
+  referencedTypes :: S.Set R.TypeName,
+  vecEquiv :: Maybe CommandName,
+  alias :: Maybe CommandName
   } deriving (Eq, Ord, Show)
 
 toCommand :: R.Command -> Command
@@ -163,7 +165,9 @@ toCommand c = Command {
     filter (not . ("struct " `L.isPrefixOf`) . R.unTypeName) $
     DM.catMaybes $
     map (R.protoPtype . R.paramProto) $
-    (pr : ps) }
+    (pr : ps),
+  vecEquiv = (CommandName . R.unName) `fmap` R.commandVecEquiv c,
+  alias = (CommandName . R.unName) `fmap` R.commandAlias c }
   where pr = R.Param { R.paramLen = Nothing, R.paramProto = R.commandProto c }
         ps = R.commandParams c
         varSupply = map (R.TypeName . showIntUsingDigits ['a' .. 'z']) [0 ..]