Generate documentation for function, data structure
I couldn't find the way to generate documentation for function with nightly erlide. So I think erlide will be better if when we select a function then generate doc for it by clicking context menu or hitting short-cut key. The generated doc should be simple and defined as template that we can configure later.
For example (from: http://www.erlang.se/doc/programming_rules.shtml#REF20875),
Function doc:
%%----------------------------------------------------------------------
get_server_statistics(Option, Pid) when pid(Pid) ->
......
Data structures doc:
%%---------------------------------------------------------------------
-record(person, {name, age, phone = [], dict = []}).
I think this feature is very helpful, at least for me :)
For example (from: http://www.erlang.se/doc/programming_rules.shtml#REF20875),
Function doc:
%%----------------------------------------------------------------------
- Function: get_server_statistics/2
- Purpose: Get various information from a process.
- Args: Option is normal|all.
- Returns: A list of {Key, Value}
- or {error, Reason} (if the process is dead)
get_server_statistics(Option, Pid) when pid(Pid) ->
......
Data structures doc:
%%---------------------------------------------------------------------
- Data Type: person
- where:
- name: A string (default is undefined).
- age: An integer (default is undefined).
- phone: A list of integers (default is []).
- dict: A dictionary containing various information about the person.
- A {Key, Value} list (default is the empty list).
-record(person, {name, age, phone = [], dict = []}).
I think this feature is very helpful, at least for me :)
Leave a comment
on 2014-03-15 21:59 *
By Vlad Dumitrescu
Assigned to set to Vlad Dumitrescu
Assigned to set to Vlad Dumitrescu
on 2014-03-15 21:59 *
By Vlad Dumitrescu
Component set to editing support
Component set to editing support
on 2014-03-15 22:00 *
By Vlad Dumitrescu
Category changed from Bug to New feature
Category changed from Bug to New feature
on 2014-03-16 14:43 *
By Vlad Dumitrescu
Note to self: Add menu under Source->Generate Element Comment (Alt+Shift+J)
on 2014-04-04 12:39 *
By Vlad Dumitrescu
Milestone changed from sprint #51 to sprint #52
Milestone changed from sprint #51 to sprint #52
on 2014-04-30 12:27 *
By Vlad Dumitrescu
Milestone changed from sprint #52 to sprint #53
Milestone changed from sprint #52 to sprint #53
on 2014-05-12 22:31 *
By Vlad Dumitrescu
Milestone changed from sprint #53 to sprint #54
Milestone changed from sprint #53 to sprint #54
on 2014-06-24 16:40 *
By Vlad Dumitrescu
Milestone changed from sprint #54 to sprint #55
Milestone changed from sprint #54 to sprint #55
on 2015-09-15 18:30 *
By Vlad Dumitrescu
Milestone changed from sprint #55 to v1.0 backlog
Milestone changed from sprint #55 to v1.0 backlog