git.iko.soy/rowtype-yoga/purescript-native
on golang help sign in
Merge pull request #1546 from trofi/master

Language.PureScript.Externs: fix haddock markup

commit5b2cc4f3780c437d9d77f200913fca3ff77a03de authorPhil Freeman <paf31@cantab.net> dateWed 21 Oct 2015, 16:37 (11 years ago) parent8178604f6f38a0
1 file changed+18−18
src/Language/PureScript/Externs.hs+18−18
src/Language/PureScript/Externs.hs+18−18
@@ -50,57 +50,57 @@ import Paths_purescript as Paths
5050-- | The data which will be serialized to an externs file
5151data ExternsFile = ExternsFile
5252 {
53− -- ^ The externs version
53+ -- | The externs version
5454 efVersion :: String
55− -- ^ Module name
55+ -- | Module name
5656 , efModuleName :: ModuleName
57− -- ^ List of module exports
57+ -- | List of module exports
5858 , efExports :: [DeclarationRef]
59− -- ^ List of module imports
59+ -- | List of module imports
6060 , efImports :: [ExternsImport]
61− -- ^ List of operators and their fixities
61+ -- | List of operators and their fixities
6262 , efFixities :: [ExternsFixity]
63− -- ^ List of type and value declaration
63+ -- | List of type and value declaration
6464 , efDeclarations :: [ExternsDeclaration]
6565 } deriving (Show, Read)
6666
6767-- | A module import in an externs file
6868data ExternsImport = ExternsImport
6969 {
70− -- ^ The imported module
70+ -- | The imported module
7171 eiModule :: ModuleName
72− -- ^ The import type: regular, qualified or hiding
72+ -- | The import type: regular, qualified or hiding
7373 , eiImportType :: ImportDeclarationType
74− -- ^ The imported-as name, for qualified imports
74+ -- | The imported-as name, for qualified imports
7575 , eiImportedAs :: Maybe ModuleName
7676 } deriving (Show, Read)
7777
7878-- | A fixity declaration in an externs file
7979data ExternsFixity = ExternsFixity
8080 {
81− -- ^ The associativity of the operator
81+ -- | The associativity of the operator
8282 efAssociativity :: Associativity
83− -- ^ The precedence level of the operator
83+ -- | The precedence level of the operator
8484 , efPrecedence :: Precedence
85− -- ^ The operator symbol
85+ -- | The operator symbol
8686 , efOperator :: String
8787 } deriving (Show, Read)
8888
8989-- | A type or value declaration appearing in an externs file
9090data ExternsDeclaration =
91− -- ^ A type declaration
91+ -- | A type declaration
9292 EDType
9393 { edTypeName :: ProperName
9494 , edTypeKind :: Kind
9595 , edTypeDeclarationKind :: TypeKind
9696 }
97− -- ^ A type synonym
97+ -- | A type synonym
9898 | EDTypeSynonym
9999 { edTypeSynonymName :: ProperName
100100 , edTypeSynonymArguments :: [(String, Maybe Kind)]
101101 , edTypeSynonymType :: Type
102102 }
103− -- ^ A data construtor
103+ -- | A data construtor
104104 | EDDataConstructor
105105 { edDataCtorName :: ProperName
106106 , edDataCtorOrigin :: DataDeclType
@@ -108,19 +108,19 @@ data ExternsDeclaration =
108108 , edDataCtorType :: Type
109109 , edDataCtorFields :: [Ident]
110110 }
111− -- ^ A value declaration
111+ -- | A value declaration
112112 | EDValue
113113 { edValueName :: Ident
114114 , edValueType :: Type
115115 }
116− -- ^ A type class declaration
116+ -- | A type class declaration
117117 | EDClass
118118 { edClassName :: ProperName
119119 , edClassTypeArguments :: [(String, Maybe Kind)]
120120 , edClassMembers :: [(Ident, Type)]
121121 , edClassConstraints :: [Constraint]
122122 }
123− -- ^ An instance declaration
123+ -- | An instance declaration
124124 | EDInstance
125125 { edInstanceClassName :: Qualified ProperName
126126 , edInstanceName :: Ident