Commit f9e468f7 authored by Camil Staps's avatar Camil Staps 🍃

Language report documentation moved to BasicResult

parent 6825d4cd
......@@ -65,6 +65,17 @@ from GenEq import generic gEq
, distance :: Int //* A distancy measure, lower is more relevant
, builtin :: Maybe Bool //* Whether this is a builtin function
, documentation :: Maybe String //* The CleanDoc description for this result
, langrep_documentation :: Maybe [CleanLangReportLocation] //* Documentation in the Clean language report
}
/**
* A location in a Clean language report
*/
:: CleanLangReportLocation =
{ clr_version :: String //* The version of the report
, clr_section :: String //* The section in the report
, clr_file :: String //* The HTML file that section belongs to
, clr_heading :: String //* A heading in the HTML file
}
/**
......@@ -175,7 +186,6 @@ from GenEq import generic gEq
:: SyntaxResultExtras =
{ syntax_title :: String //* The name of the construct
, syntax_code :: [String] //* Strings describing the construct, as short as possible
, syntax_doc_location :: [SyntaxDocLocation] //* Where to find documentation on the construct
, syntax_examples :: [SyntaxExample] //* Some code examples (should include comments)
}
......@@ -188,22 +198,6 @@ from GenEq import generic gEq
, cleanjs_start :: Maybe String //* The state in which clean.js should start highlighting
}
/**
* A location of syntax documentation
*/
:: SyntaxDocLocation
= CleanLangReport CleanLangReportLocation
/**
* A location in a Clean language report
*/
:: CleanLangReportLocation =
{ clr_version :: String //* The version of the report
, clr_section :: String //* The section in the report
, clr_file :: String //* The HTML file that section belongs to
, clr_heading :: String //* A heading in the HTML file
}
/**
* A location in a Clean library
*
......@@ -252,11 +246,11 @@ instance fromInt CloogleError
derive JSONEncode Request, Response, Result, ShortClassResult, BasicResult,
FunctionResultExtras, TypeResultExtras, ClassResultExtras, FunctionKind,
ModuleResultExtras, SyntaxResultExtras, SyntaxExample, SyntaxDocLocation,
ModuleResultExtras, SyntaxResultExtras, SyntaxExample,
CleanLangReportLocation, StrUnifier
derive JSONDecode Request, Response, Result, ShortClassResult, BasicResult,
FunctionResultExtras, TypeResultExtras, ClassResultExtras, FunctionKind,
ModuleResultExtras, SyntaxResultExtras, SyntaxExample, SyntaxDocLocation,
ModuleResultExtras, SyntaxResultExtras, SyntaxExample,
CleanLangReportLocation, StrUnifier
derive gEq FunctionKind
......
......@@ -19,11 +19,11 @@ import GenEq
derive JSONEncode Request, Response, Result, ShortClassResult, BasicResult,
FunctionResultExtras, TypeResultExtras, ClassResultExtras, FunctionKind,
ModuleResultExtras, SyntaxResultExtras, SyntaxExample, SyntaxDocLocation,
ModuleResultExtras, SyntaxResultExtras, SyntaxExample,
CleanLangReportLocation, StrUnifier
derive JSONDecode Request, Response, Result, ShortClassResult, BasicResult,
FunctionResultExtras, TypeResultExtras, ClassResultExtras, FunctionKind,
ModuleResultExtras, SyntaxResultExtras, SyntaxExample, SyntaxDocLocation,
ModuleResultExtras, SyntaxResultExtras, SyntaxExample,
CleanLangReportLocation, StrUnifier
derive gEq FunctionKind
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment