erlang
Running eDoc doesn't report errors
When I try to export my project in eDoc an empty documentation is generated. My code has comments following the eDoc spec.
Steps: From menu select "File" Select "Export" Under Erlang select "eDoc" Press "Next >" Select project (tick) Press "Finish"
The doc directory contains html files but none of any of my modules, basically empty.
The source files are in the src directory and I would expect the eDoc implementation in Eclipse will take the code from there when buiding the documentation. I am using a MacBook Pro OS X Yosemite.
Several HTNL files exist but they do not contain any documentation for any code.
Please explain - what html files do you get in the 'doc' folder? what do they contain?
stylesheet.css erlang.png index.html modules-frame.html overview-summary.html packages-frame.html edoc-info
Inside there is the minimum HTML without the modules or functions
Did you try with other projects? Maybe a simple one with just one file?
Have you tried to run edoc yourself on this project, from the Erlang shell?
I can't reproduce this, so we have to try to find what is different about your project.
I have run it using cmd application. After fixing some documentation errors the cmd edoc worked fine and I was able to run it from Eclipse.
Running it from Eclipse dose not show any message in the console or other views in Eclipse. So if a documentation error occurs you don't get any doc and you cannot see why.
Maybe try to build doc with only a file/module with doc errors and see it.
Thank you for you help.
Aha, ok, thanks! I will fix that.
The main issue with using Erlang tools from Eclipse is that most are command-line tools and don't return errors, but print them out and there is no console. I have to hook into the IO system and get those messages.
On Mon, Nov 24, 2014 at 11:41 AM, amadeoas [email protected] wrote:
I have run it using cmd application. After fixing some documentation errors the cmd edoc worked fine and I was able to run it from Eclipse.
Running it from Eclipse dose not show any message in the console or other views in Eclipse. So if a documentation error occurs you don't get any doc and you cannot see why.
Maybe try to build doc with only a file/module with doc errors and see it.
Thank you for you help.
Sent from my Samsung Galaxy smartphone.
-------- Original message -------- From: Vlad Dumitrescu [email protected] Date:21/11/2014 21:55 (GMT+00:00) To: erlide/erlide [email protected] Cc: Amadeo Asco [email protected] Subject: Re: [erlide] Failed to generate like Javadoc documentation using eDoc (#205)
Did you try with other projects? Maybe a simple one with just one file?
Have you tried to run edoc yourself on this project, from the Erlang shell?
I can't reproduce this, so we have to try to find what is different about your project.
— Reply to this email directly or view it on GitHub< https://github.com/erlide/erlide/issues/205#issuecomment-64044156>.
— Reply to this email directly or view it on GitHub https://github.com/erlide/erlide/issues/205#issuecomment-64176256.
Thank you.
Would it be possible to allow setting some of the argument when building so you can specify things like including todo, private, etc. I use
erl -noshell -run edoc_run packages '[""]' '[{source_path, ["./src"]}, {dir,"./doc"}, {private,true}, {todo,true}]'
to build my documentation from cmdline and it would be nice if the same result could be achieved in the Eclipse UI.
There may be a place where to add suggestions like this. If there is one please you let me know where and I will move it to there. Thank you.
If you can just put this request into a new issue, it will be enough. Thanks!
On Mon, Nov 24, 2014 at 12:11 PM, amadeoas [email protected] wrote:
Thank you.
Would it be possible to allow setting some of the argument when building so you can specify things like including todo, private, etc. I use
erl -noshell -run edoc_run packages '[""]' '[{source_path, ["./src"]}, {dir,"./doc"}, {private,true}, {todo,true}]'
to build my documentation from cmdline and it would be nice if the same result could be achieved in the Eclipse UI.
There may be a place where to add suggestions like this. If there is one please you let me know where and I will move it to there. Thank you.
—————————————————— Amadeo Ascó, Software Pilot
Trifork Leeds Ltd, Round Foundry Media Centre, Foundry Street, Leeds LS11 5QP, UK
• uk.linkedin.com/pub/amadeo-ascó/83/168/577/ http://uk.linkedin.com/pub/amadeo-asc%C3%B3/83/168/577/< http://uk.linkedin.com/pub/amadeo-ascó/83/168/577/>
On 24 Nov 2014, at 10:49, Vlad Dumitrescu <[email protected] mailto:[email protected]> wrote:
Aha, ok, thanks! I will fix that.
The main issue with using Erlang tools from Eclipse is that most are command-line tools and don't return errors, but print them out and there is no console. I have to hook into the IO system and get those messages.
On Mon, Nov 24, 2014 at 11:41 AM, amadeoas <[email protected] mailto:[email protected]> wrote:
I have run it using cmd application. After fixing some documentation errors the cmd edoc worked fine and I was able to run it from Eclipse.
Running it from Eclipse dose not show any message in the console or other views in Eclipse. So if a documentation error occurs you don't get any doc and you cannot see why.
Maybe try to build doc with only a file/module with doc errors and see it.
Thank you for you help.
Sent from my Samsung Galaxy smartphone.
-------- Original message -------- From: Vlad Dumitrescu <[email protected]<mailto: [email protected]>> Date:21/11/2014 21:55 (GMT+00:00) To: erlide/erlide <[email protected]<mailto: [email protected]>> Cc: Amadeo Asco <[email protected]mailto:[email protected]> Subject: Re: [erlide] Failed to generate like Javadoc documentation using eDoc (#205)
Did you try with other projects? Maybe a simple one with just one file?
Have you tried to run edoc yourself on this project, from the Erlang shell?
I can't reproduce this, so we have to try to find what is different about your project.
— Reply to this email directly or view it on GitHub< https://github.com/erlide/erlide/issues/205#issuecomment-64044156>.
— Reply to this email directly or view it on GitHub https://github.com/erlide/erlide/issues/205#issuecomment-64176256.
— Reply to this email directly or view it on GitHub< https://github.com/erlide/erlide/issues/205#issuecomment-64177113>.
— Reply to this email directly or view it on GitHub https://github.com/erlide/erlide/issues/205#issuecomment-64179219.