Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
What's new
10
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Open sidebar
Cloogle
Cloogle
Commits
898bf915
Verified
Commit
898bf915
authored
May 07, 2018
by
Camil Staps
🚀
Browse files
Options
Browse Files
Download
Plain Diff
Merge branch 'master' of github.com:clean-cloogle/Cloogle
parents
0f167708
4a1a8f27
Changes
5
Hide whitespace changes
Inline
Side-by-side
Showing
5 changed files
with
22 additions
and
13 deletions
+22
-13
Doc.dcl
Doc.dcl
+5
-0
Doc.icl
Doc.icl
+3
-0
README.md
README.md
+12
-12
Search.icl
Search.icl
+1
-0
libcloogle
libcloogle
+1
-1
No files found.
Doc.dcl
View file @
898bf915
...
...
@@ -17,6 +17,7 @@ class docParams d :: !d -> [Description]
class
docVars
d
::
!
d
->
[
Description
]
class
docResults
d
::
!
d
->
[
Description
]
class
docType
d
::
!
d
->
Maybe
Type
class
docThrows
d
::
!
d
->
[
Description
]
class
docMembers
d
::
!
d
->
[
Maybe
ClassMemberDoc
]
class
docFields
d
::
!
d
->
Maybe
[
Maybe
Description
]
class
docConstructors
d
::
!
d
->
Maybe
[
Maybe
ConstructorDoc
]
...
...
@@ -41,6 +42,7 @@ derive gDefault ModuleDoc
,
vars
::
[
Description
]
//* Descriptions of the type variables (for generics)
,
results
::
[
Description
]
//* Descriptions of the result(s, for tuples)
,
type
::
Maybe
Type
//* The type (for macros)
,
throws
::
[
Description
]
//* The exceptions it may throw (iTasks)
}
instance
docDescription
FunctionDoc
...
...
@@ -48,6 +50,7 @@ instance docParams FunctionDoc
instance
docVars
FunctionDoc
instance
docResults
FunctionDoc
instance
docType
FunctionDoc
instance
docThrows
FunctionDoc
derive
gDefault
FunctionDoc
/**
...
...
@@ -59,12 +62,14 @@ derive gDefault FunctionDoc
,
params
::
[
Description
]
,
results
::
[
Description
]
,
type
::
Maybe
Type
,
throws
::
[
Description
]
}
instance
docDescription
ClassMemberDoc
instance
docParams
ClassMemberDoc
instance
docResults
ClassMemberDoc
instance
docType
ClassMemberDoc
instance
docThrows
ClassMemberDoc
derive
gDefault
ClassMemberDoc
/**
...
...
Doc.icl
View file @
898bf915
...
...
@@ -32,11 +32,13 @@ instance docParams FunctionDoc where docParams d = d.FunctionDoc.param
instance
docVars
FunctionDoc
where
docVars
d
=
d
.
FunctionDoc
.
vars
instance
docResults
FunctionDoc
where
docResults
d
=
d
.
FunctionDoc
.
results
instance
docType
FunctionDoc
where
docType
d
=
d
.
FunctionDoc
.
type
instance
docThrows
FunctionDoc
where
docThrows
d
=
d
.
FunctionDoc
.
throws
instance
docDescription
ClassMemberDoc
where
docDescription
d
=
d
.
ClassMemberDoc
.
description
instance
docParams
ClassMemberDoc
where
docParams
d
=
d
.
ClassMemberDoc
.
params
instance
docResults
ClassMemberDoc
where
docResults
d
=
d
.
ClassMemberDoc
.
results
instance
docType
ClassMemberDoc
where
docType
d
=
d
.
ClassMemberDoc
.
type
instance
docThrows
ClassMemberDoc
where
docThrows
d
=
d
.
ClassMemberDoc
.
throws
instance
docDescription
ConstructorDoc
where
docDescription
d
=
d
.
ConstructorDoc
.
description
instance
docParams
ConstructorDoc
where
docParams
d
=
d
.
ConstructorDoc
.
params
...
...
@@ -69,6 +71,7 @@ functionToClassMemberDoc d =
,
params
=
d
.
FunctionDoc
.
params
,
results
=
d
.
FunctionDoc
.
results
,
type
=
d
.
FunctionDoc
.
type
,
throws
=
d
.
FunctionDoc
.
throws
}
addClassMemberDoc
::
!
ClassDoc
!(
Maybe
ClassMemberDoc
)
->
ClassDoc
...
...
README.md
View file @
898bf915
...
...
@@ -89,18 +89,18 @@ Some simple markup is allowed in documentation:
The tables below describe which fields and documentation types can be used for
different syntax elements, and what they should document.
| | Description |
`@param`
|
`@result`
|
`@type`
|
`@var`
|
`@representation`
|--------------|-------------|----------|-----------|---------|--------|-------------------
| Class | !
[][
y
]
| !
[][
y
]
<sup>
1
</sup>
| !
[][
y
]
<sup>
1
</sup>
| | !
[][
y
]
|
| Class member | !
[][
y
]
| !
[][
y
]
| !
[][
y
]
| | |
| Constructor | !
[][
y
]
| | | | |
| Function | !
[][
y
]
| !
[][
y
]
| !
[][
y
]
| | |
| Generic | !
[][
y
]
| !
[][
y
]
| !
[][
y
]
| | !
[][
y
]
|
| Instance | | | | | |
| Macro | !
[][
y
]
| !
[][
y
]
| !
[][
y
]
| !
[][
y
]
<sup>
2
</sup>
| |
| Module | !
[][
y
]
| | | | |
| Record field | !
[][
y
]
| | | | |
| Type | !
[][
y
]
| | | | !
[][
y
]
| !
[][
y
]
, for type synonyms
| | Description |
`@param`
|
`@result`
|
`@type`
|
`@var`
|
`@representation`
|
`@throws`
|--------------|-------------|----------|-----------|---------|--------|-------------------
|----------
| Class | !
[][
y
]
| !
[][
y
]
<sup>
1
</sup>
| !
[][
y
]
<sup>
1
</sup>
| | !
[][
y
]
| !
[][
y
]
| Class member | !
[][
y
]
| !
[][
y
]
| !
[][
y
]
| | |
| !
[][
y
]
| Constructor | !
[][
y
]
| | | | |
|
| Function | !
[][
y
]
| !
[][
y
]
| !
[][
y
]
| | |
|
| Generic | !
[][
y
]
| !
[][
y
]
| !
[][
y
]
| | !
[][
y
]
|
|
| Instance | | | | | |
|
| Macro | !
[][
y
]
| !
[][
y
]
| !
[][
y
]
| !
[][
y
]
<sup>
2
</sup>
| |
|
| Module | !
[][
y
]
| | | | |
|
| Record field | !
[][
y
]
| | | | |
|
| Type | !
[][
y
]
| | | | !
[][
y
]
| !
[][
y
]
, for type synonyms
|
<sup>
1: only for shorthand classes like
`class zero a :: a`
, where there is no
other place for the documentation of the class member.
</sup>
...
...
Search.icl
View file @
898bf915
...
...
@@ -133,6 +133,7 @@ makeResult orgsearchtype allsyns usedsyns (entry, annots) db
,
generic_var_doc
=
docVars
<$>
fe
.
fe_documentation
,
result_doc
=
docResults
<$>
fe
.
fe_documentation
,
type_doc
=
concat
<$>
print
False
<$>
(
docType
=<<
fe
.
fe_documentation
)
,
throws_doc
=
docThrows
<$>
fe
.
fe_documentation
}),
db
)
with
toStrUnifier
::
Unifier
->
StrUnifier
...
...
libcloogle
@
cac3a305
Compare
ffd6cfa0
...
cac3a305
Subproject commit
ffd6cfa0a8d6913c30b3fee9fe70ebaa596940b
5
Subproject commit
cac3a3050bbbd7d131e166c2a9a708e5338518c
5
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment