c2hs icon indicating copy to clipboard operation
c2hs copied to clipboard

Haddock comments on enum constructors

Open gilgamec opened this issue 4 years ago • 0 comments

Haddock comments in #fun commands are passed on to the generated file, so that imported function arguments can be documented. Is it possible to do the same for imported enums?

For example, if the C header file foo.h is

enum MyEnum{ FOO = 1, BAR = 2 };

and the CHS file is

#include "foo.h"

{# enum MyEnum
   as MyEnum
      { FOO as Foo -- ^ foo
      , BAR as Bar -- ^ bar
      }
#}

then the generated hs file defines MyEnum as

data MyEnum = Foo
            | Bar

The haddock comments have disappeared. Is it possible to maintain them during generation, so the generated file contains

data MyEnum = Foo -- ^ foo
            | Bar -- ^ bar

gilgamec avatar Nov 23 '21 17:11 gilgamec