Databases
StackOverflow2013
Postsdbo
POHaddock on record fields Haskell
 

Note that there are some explanatory texts on larger screens.

plurals
  1. POHaddock on record fields Haskell
    primarykey
    data
    text
    <p>I am trying write haddock for record fields on an interface. Only some of the fields are exported so I only want some of them documented. I read the documentation page here: <a href="http://www.haskell.org/haddock/doc/html/ch03s02.html#id565178" rel="nofollow">http://www.haskell.org/haddock/doc/html/ch03s02.html#id565178</a></p> <p>However, I cannot seem to get this to work. Here is the section I am trying to write haddock for:</p> <pre><code>{-| Describes a Clients connection and provides an interface for storing data associated with the client. Each client will be given a unique cid and are Eq if their cid's are Eq. A ClientConn comes packaged with two functions for storing additional information in Strings, lookup and modify. The lookup function takes a key and returns the current value of the key or the empty string if it has never been set. The modify function takes a key and value and updates it such that the next call to lookup with that key will return the value provided. -} data ClientConn = ClientConn { -- | The Unique ID for this client cid :: Integer, -- | A lookup function for this client lookup :: (String -&gt; IO String), -- | A modify function for this client modify :: (String -&gt; String -&gt; IO ()), chandle :: Handle, host :: Net.HostName, pid :: Net.PortNumber, msgList :: List String, dead :: MVar Bool, timestamp :: TimeStamp, tid :: MVar (ThreadId, ThreadId), lock :: MVar Lock.Lock} </code></pre> <p>The comment for the data type shows up correctly in the generated haddock. However, none of the records are generated. I would like it to generate for the cid, lookup, and modify records.</p> <p>Thanks in advance!</p> <p>The full source can be found here: <a href="https://github.com/jcollard/simple-server/blob/master/Network/SimpleServer.hs" rel="nofollow">https://github.com/jcollard/simple-server/blob/master/Network/SimpleServer.hs</a></p>
    singulars
    1. PO
      singulars
      1. PTAnswer
    1. This table or related slice is empty.
    1. PTQuestion
    1. USJoe
    1. USJoe
    plurals
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    1. PO
      singulars
      1. PTAnswer
    1. VO
      singulars
      1. POHaddock on record fields Haskell
      1. This table or related slice is empty.
      1. VTUpMod
    1. COI've run into various bugs with haddock'ing records before that were almost always worked around by adding newlines before the haddock comment. Does that work here?
      singulars
      1. POHaddock on record fields Haskell
      1. USDaniel Wagner
    2. COI added a new line before each haddock comment with no change to the generated output. I've also tried it with {-| -}.
      singulars
      1. POHaddock on record fields Haskell
      1. USJoe
    3. COWhat does your module's export line say?
      singulars
      1. POHaddock on record fields Haskell
      1. USDaniel Wagner
 

Querying!

 
Guidance
A row detail

Detail views are divided into sections. All the information in the data section comes from columns in the selected row. The other sections display data from other, related rows.

Related data can be related in a to-one or a to-many fashion. Captions of data related in a to-many fashion link to a list view showing a filtered view of the table.

Try moving around until you find a non-empty to-many entry and click on the label to get to one. You can move back to the root by clicking on the database name in the header.

SQuiL has stopped working due to an internal error.

If you are curious you may find further information in the browser console, which is accessible through the devtools (F12).

Reload