This has come up in the review of D538 too. Once processed by haddock the
online documentation links through to the hsSyn/ApiAnnotation module where
more detail is given.
I am not sure what the best way is to add an internal source code link to
it too without disturbing the haddock. I am open for suggestions.
Alan
On Thu, Jan 15, 2015 at 3:16 PM, Jan Stolarek
Alan, devs,
since API annotations were added some data types in the source code have extra comments related to these annotations, eg.
-- | A type or class declaration. data TyClDecl name = -- | @type/data family T :: *->*@ -- -- - 'ApiAnnotation.AnnKeywordId' : 'ApiAnnotation.AnnType', -- 'ApiAnnotation.AnnData', -- 'ApiAnnotation.AnnFamily','ApiAnnotation.AnnWhere', -- 'ApiAnnotation.AnnOpen','ApiAnnotation.AnnDcolon', -- 'ApiAnnotation.AnnClose' FamDecl { tcdFam :: FamilyDecl name }
I'm totally clueless about what these comments mean. Where can I find an explanation? Couldn't find anything on the wiki.
Janek