#1377
- Created on2015-03-19 14:22
- Reported by
- StatusNew
- PriorityNormal (3)
- Assigned to
- Milestone
- Plan Level-
- EstimateNone/Small/Medium/Large Small
- Due Date-
edoc shows unformatted doc
Hi there,
I started to use edoc. From the following source:
----------------------
store(Bucket,Key,Value) ->
store(Bucket,Key,Value,msjson)
.
-----------------------------
with the command of:
edoc:application(multiserver,".",[]).
-----------------------------
htmls are generated into the doc directory. and with a browser it is nicely formatted:
store/3
store(Bucket::term(), Key::term(), Value::term()) -> Result::ok | {error, term()}
this module generates a record in the database
-----------------------
In eclipse in edoc view (or just when hover on the strore function it shows:
@spec store(Bucket:: term(), Key :: term(), Value :: term()) -> Result :: ok | {error,term()}
@doc this module generates a record
in the database
@end
---------------------------
I copied the whole doc directory to doc/html also, no change.
Could you help me to understand here erlide looks for edoc html formatted documents please?
Additional information is that I needed to open an erlang shell to make the command edoc:applciation work. Inside eclipse it runs but does not generate the htmls in the doc directory. Maybe somewhere else? Where?
Thanks and kind regards,
Zsolt
zsoci@lamardan.com
==================================
N/A
==================================
N/A
I started to use edoc. From the following source:
----------------------
- @spec store(Bucket:: term(), Key :: term(), Value :: term()) -> Result :: ok | {error,term()}
- @doc this module generates a record
- in the database
- @end
store(Bucket,Key,Value) ->
store(Bucket,Key,Value,msjson)
.
-----------------------------
with the command of:
edoc:application(multiserver,".",[]).
-----------------------------
htmls are generated into the doc directory. and with a browser it is nicely formatted:
store/3
store(Bucket::term(), Key::term(), Value::term()) -> Result::ok | {error, term()}
this module generates a record in the database
-----------------------
In eclipse in edoc view (or just when hover on the strore function it shows:
@spec store(Bucket:: term(), Key :: term(), Value :: term()) -> Result :: ok | {error,term()}
@doc this module generates a record
in the database
@end
---------------------------
I copied the whole doc directory to doc/html also, no change.
Could you help me to understand here erlide looks for edoc html formatted documents please?
Additional information is that I needed to open an erlang shell to make the command edoc:applciation work. Inside eclipse it runs but does not generate the htmls in the doc directory. Maybe somewhere else? Where?
Thanks and kind regards,
Zsolt
zsoci@lamardan.com
==================================
N/A
==================================
N/A
Leave a comment
on 2015-03-19 15:40 *
By Vlad Dumitrescu
Assigned to set to Vlad Dumitrescu
Assigned to set to Vlad Dumitrescu
Hello Zoltan!
Unfortunately, the edoc support is not complete yet. We only show html for the OTP libraries (which are not edoc)
Likewise, there is no eclipse command to generate the docs, yet. The implementation was started, but probably other things got in the way.
Sorry about the inconvenience. I will make this higher priority, but at the moment I have a bit of backlog to go through, so it may take a while.
Unfortunately, the edoc support is not complete yet. We only show html for the OTP libraries (which are not edoc)
Likewise, there is no eclipse command to generate the docs, yet. The implementation was started, but probably other things got in the way.
Sorry about the inconvenience. I will make this higher priority, but at the moment I have a bit of backlog to go through, so it may take a while.
Hi Vlad,
Really this is not a problem. I think it is low priority. The source of the issue is that on http://erlide.sourceforge.net/erlide.html I found the information below.
This is misleading and I spent a day to make it happen. As no success, I opened the ticket as I used to do :)
So instead of building this in right away or on high priortiy, I suggest to modify the documentation that only OTP docs are handled by Edoc viewer for Erlide for the time being.
You can of course close the ticket and thanks for the clarification.
cheers
Zsolt
--------------------------------------
EDoc view
Opening a "Edoc" view (in Window → Show view → Erlang) will display the documentation for the function where the cursor is. The documentation is also shown in a hover window, when the mouse cursor is above a function call.
The OTP documentation is shown, if installed on your system. Also, if the project contains HTML documentation that is located in an OTP-like location (i.e. in a doc/html directory in the project ), then this documentation is also shown.
Really this is not a problem. I think it is low priority. The source of the issue is that on http://erlide.sourceforge.net/erlide.html I found the information below.
This is misleading and I spent a day to make it happen. As no success, I opened the ticket as I used to do :)
So instead of building this in right away or on high priortiy, I suggest to modify the documentation that only OTP docs are handled by Edoc viewer for Erlide for the time being.
You can of course close the ticket and thanks for the clarification.
cheers
Zsolt
--------------------------------------
EDoc view
Opening a "Edoc" view (in Window → Show view → Erlang) will display the documentation for the function where the cursor is. The documentation is also shown in a hover window, when the mouse cursor is above a function call.
The OTP documentation is shown, if installed on your system. Also, if the project contains HTML documentation that is located in an OTP-like location (i.e. in a doc/html directory in the project ), then this documentation is also shown.
on 2015-03-19 16:19 *
By Vlad Dumitrescu
I understand now. I'm not sure where that functionality went, I think it never worked perfectly, we forgot to add tests for it and when it broke down completely nobody noticed.
I will check the code once again and either update it or the docs.
Thanks for the report!
I will check the code once again and either update it or the docs.
Thanks for the report!
Tx Vlad,
btw if you will take a look at the code sometimes, an interesting scenario remains to be tracked. When you issue the command edoc:application from the debug console, it returns fine but I cannot find the generated files. So maybe the command puts it somewhere. Just would be better to know if it makes files somewhere we do not know about.
cheers,
Zsolt
btw if you will take a look at the code sometimes, an interesting scenario remains to be tracked. When you issue the command edoc:application from the debug console, it returns fine but I cannot find the generated files. So maybe the command puts it somewhere. Just would be better to know if it makes files somewhere we do not know about.
cheers,
Zsolt
on 2015-03-19 19:57 *
By Vlad Dumitrescu
Sure, I will look at that too.
In the meanwhile, you can run a "find / -name module_from_your_project.html" to see if the files were created somewhere
In the meanwhile, you can run a "find / -name module_from_your_project.html" to see if the files were created somewhere
on 2015-09-15 13:00 *
By Vlad Dumitrescu
Milestone set to v1.0 backlog
Milestone set to v1.0 backlog