git.iko.soy/rowtype-yoga/purescript-native
on golang help sign in
Language.PureScript.Externs: fix haddock markup
f6f38a0Sergei Trofimovich
src/Language/PureScript/Externs.hs+18−18
@@ -50,57 +50,57 @@ import Paths_purescript as Paths
50-- | The data which will be serialized to an externs file
50-- | The data which will be serialized to an externs file
51data ExternsFile = ExternsFile
51data ExternsFile = ExternsFile
52 {
52 {
53− -- ^ The externs version
53+ -- | The externs version
54 efVersion :: String
54 efVersion :: String
55− -- ^ Module name
55+ -- | Module name
56 , efModuleName :: ModuleName
56 , efModuleName :: ModuleName
57− -- ^ List of module exports
57+ -- | List of module exports
58 , efExports :: [DeclarationRef]
58 , efExports :: [DeclarationRef]
59− -- ^ List of module imports
59+ -- | List of module imports
60 , efImports :: [ExternsImport]
60 , efImports :: [ExternsImport]
61− -- ^ List of operators and their fixities
61+ -- | List of operators and their fixities
62 , efFixities :: [ExternsFixity]
62 , efFixities :: [ExternsFixity]
63− -- ^ List of type and value declaration
63+ -- | List of type and value declaration
64 , efDeclarations :: [ExternsDeclaration]
64 , efDeclarations :: [ExternsDeclaration]
65 } deriving (Show, Read)
65 } deriving (Show, Read)
66
66
67-- | A module import in an externs file
67-- | A module import in an externs file
68data ExternsImport = ExternsImport
68data ExternsImport = ExternsImport
69 {
69 {
70− -- ^ The imported module
70+ -- | The imported module
71 eiModule :: ModuleName
71 eiModule :: ModuleName
72− -- ^ The import type: regular, qualified or hiding
72+ -- | The import type: regular, qualified or hiding
73 , eiImportType :: ImportDeclarationType
73 , eiImportType :: ImportDeclarationType
74− -- ^ The imported-as name, for qualified imports
74+ -- | The imported-as name, for qualified imports
75 , eiImportedAs :: Maybe ModuleName
75 , eiImportedAs :: Maybe ModuleName
76 } deriving (Show, Read)
76 } deriving (Show, Read)
77
77
78-- | A fixity declaration in an externs file
78-- | A fixity declaration in an externs file
79data ExternsFixity = ExternsFixity
79data ExternsFixity = ExternsFixity
80 {
80 {
81− -- ^ The associativity of the operator
81+ -- | The associativity of the operator
82 efAssociativity :: Associativity
82 efAssociativity :: Associativity
83− -- ^ The precedence level of the operator
83+ -- | The precedence level of the operator
84 , efPrecedence :: Precedence
84 , efPrecedence :: Precedence
85− -- ^ The operator symbol
85+ -- | The operator symbol
86 , efOperator :: String
86 , efOperator :: String
87 } deriving (Show, Read)
87 } deriving (Show, Read)
88
88
89-- | A type or value declaration appearing in an externs file
89-- | A type or value declaration appearing in an externs file
90data ExternsDeclaration =
90data ExternsDeclaration =
91− -- ^ A type declaration
91+ -- | A type declaration
92 EDType
92 EDType
93 { edTypeName :: ProperName
93 { edTypeName :: ProperName
94 , edTypeKind :: Kind
94 , edTypeKind :: Kind
95 , edTypeDeclarationKind :: TypeKind
95 , edTypeDeclarationKind :: TypeKind
96 }
96 }
97− -- ^ A type synonym
97+ -- | A type synonym
98 | EDTypeSynonym
98 | EDTypeSynonym
99 { edTypeSynonymName :: ProperName
99 { edTypeSynonymName :: ProperName
100 , edTypeSynonymArguments :: [(String, Maybe Kind)]
100 , edTypeSynonymArguments :: [(String, Maybe Kind)]
101 , edTypeSynonymType :: Type
101 , edTypeSynonymType :: Type
102 }
102 }
103− -- ^ A data construtor
103+ -- | A data construtor
104 | EDDataConstructor
104 | EDDataConstructor
105 { edDataCtorName :: ProperName
105 { edDataCtorName :: ProperName
106 , edDataCtorOrigin :: DataDeclType
106 , edDataCtorOrigin :: DataDeclType
@@ -108,19 +108,19 @@ data ExternsDeclaration =
108 , edDataCtorType :: Type
108 , edDataCtorType :: Type
109 , edDataCtorFields :: [Ident]
109 , edDataCtorFields :: [Ident]
110 }
110 }
111− -- ^ A value declaration
111+ -- | A value declaration
112 | EDValue
112 | EDValue
113 { edValueName :: Ident
113 { edValueName :: Ident
114 , edValueType :: Type
114 , edValueType :: Type
115 }
115 }
116− -- ^ A type class declaration
116+ -- | A type class declaration
117 | EDClass
117 | EDClass
118 { edClassName :: ProperName
118 { edClassName :: ProperName
119 , edClassTypeArguments :: [(String, Maybe Kind)]
119 , edClassTypeArguments :: [(String, Maybe Kind)]
120 , edClassMembers :: [(Ident, Type)]
120 , edClassMembers :: [(Ident, Type)]
121 , edClassConstraints :: [Constraint]
121 , edClassConstraints :: [Constraint]
122 }
122 }
123− -- ^ An instance declaration
123+ -- | An instance declaration
124 | EDInstance
124 | EDInstance
125 { edInstanceClassName :: Qualified ProperName
125 { edInstanceClassName :: Qualified ProperName
126 , edInstanceName :: Ident
126 , edInstanceName :: Ident