[erlang-patches] How to get Data Types section in documentation?

Fredrik <>
Fri Feb 1 08:58:54 CET 2013


On 01/29/2013 04:50 PM, Bengt Kleberg wrote:
> Greetings,
>
> What should I do to the module slave.erl to get a Data Types section in
> the documentation?
>
> I am updating the slave module documentation. I have added some data
> types. There is no Data Types section in the current documentation. As
> an example of how to do I am looking at the array module. It has a Data
> types section in the documentation. I can not find anything in array.erl
> that tells the documentation builder to add the Data Types section. How
> is it done?
>
> For slave.erl I do get a link from my type
> (lib/stdlib-1.19/doc/html/slave.html#type-start_options), but there is
> no target for that link.
>
>
> bengt
>
>
> _______________________________________________
> erlang-patches mailing list
> 
> http://erlang.org/mailman/listinfo/erlang-patches
Hello Bengt and sorry for the late answer. You'll have to have a look at 
in doc/src directory. In the example you are given, you can see in the 
stdlib/doc/src/array.xml that you can specify the datatype with 
"<datatypes><datatype>..</datatype></datatypes>"
Then you'll have to rebuild the documentation with make release_docs
Hope this exaplains it :)


-- 

BR Fredrik Gustafsson
Erlang OTP Team



More information about the erlang-patches mailing list