[erlang-questions] Documentation Format Changes (erldocs)

Lukas Larsson lukas.larsson@REDACTED
Mon Jun 13 12:03:28 CEST 2011

Hi Dale!

All of the documentation is right now being reworked to generate type information from the specs in the source instead of manually writing them. <name name= "keymerge" arity= "3" /> tells docbuilder (I think) to generate the type description from the specs instead of the XML file. If you dig around in the source code of docbuilder/edoc there should be functions somewhere there which you can use to generate type information for erldocs.

----- Original Message -----
From: "Dale Harvey" <dale@REDACTED>
To: "erlang-questions" <erlang-questions@REDACTED>
Sent: Sunday, 12 June, 2011 02:25:29 GMT +01:00 Amsterdam / Berlin / Bern / Rome / Stockholm / Vienna
Subject: [erlang-questions] Documentation Format Changes (erldocs)

Hey all 

I was wondering about the changes in the format documentation sources, in the last release I noticed a few function definitions changed from 

<name> keymember(Key, N, TupleList) -> boolean() </name> 
<fsummary> Test for membership of a list of tuples </fsummary> 
<v> Key = term() </v> 
<v> N = 1..tuple_size(Tuple) </v> 
<v> TupleList = [Tuple] </v> 
<v>   Tuple = tuple() </v> 
</type> to 

<name name= "keymerge" arity= "3" /> 
<fsummary> Merge two key-sorted lists of tuples </fsummary> 
<type_desc variable= "N" > 1..tuple_size(Tuple) </type_desc> 
https://github.com/erlang/otp/blob/dev/lib/stdlib/doc/src/lists.xml#L299 is the source for these changes, somehow the recent erlang documention ( http://www.erlang.org/doc/man/lists.html#keymerge-3 ) shows the full parameter list information and I am quite confused at how that can be derived from the source xml. 

I was also just curious about the reason for the change and what was planned for going forward 

since http://erldocs.com/R14B03/stdlib/lists.html?i=0&search=lists%20keymerge#keymerge/3 
is a lot less useful than http://erldocs.com/R14B02/stdlib/lists.html?i=0&search=lists%20keymerge#keymerge/3 

Cheers, good work on the new release 

erlang-questions mailing list

More information about the erlang-questions mailing list