on master help sign in
Added more Haddock
4aec152Philip Rasmussen
src/Idris/IdrisDoc.hs+9
@@ -77,10 +77,19 @@ generateDocs ist nss' out =
77
77
78-- ----------------------------------------------------------------- [ Types ]
78-- ----------------------------------------------------------------- [ Types ]
79
79
80+-- | Either an error message or a result
80type Failable = Either String
81type Failable = Either String
82+
83+-- | Internal representation of a fully qualified namespace name
81type NsName = [T.Text]
84type NsName = [T.Text]
85+
86+-- | All information to be documented about a single namespace member
82type NsItem = (Name, Maybe Docs, Accessibility)
87type NsItem = (Name, Maybe Docs, Accessibility)
88+
89+-- | All information to be documented about a namespace
83type NsInfo = [NsItem]
90type NsInfo = [NsItem]
91+
92+-- | A map from namespace names to information about them
84type NsDict = M.Map NsName NsInfo
93type NsDict = M.Map NsName NsInfo
85
94
86-- --------------------------------------------------------------- [ Utility ]
95-- --------------------------------------------------------------- [ Utility ]