Scaladoc auto-generation

[Nils Kilden-Pedersen]

How do I disable Scaladoc auto-generation when creating a new class?

[Simon Schäfer]

On 06/20/2015 07:32 AM, Nils Kilden-Pedersen wrote:

How do I disable Scaladoc auto-generation when creating a new class?

I don't understand, what do you mean by Scaladoc auto-generation? What exactly do you see/What exactly happens?

--
You received this message because you are subscribed to the Google Groups "Scala IDE User" group.
To unsubscribe from this group and stop receiving emails from it, send an email to scala-ide-use...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/scala-ide-user/CABDULvXQyDT0sN%3DR%2BMMafLXrct50kAFN-aepVmn4uJ1k8tDxvA%40mail.gmail.com.
For more options, visit https://groups.google.com/d/optout.

[iulian dragos]

There's a template for each class/trait/object wizard. If you go to Preferences/Editor/Templates you will see a number of templates starting with `wizard_`. Edit them to remove the scaladoc.

To view this discussion on the web visit https://groups.google.com/d/msgid/scala-ide-user/5585208C.4090203%40antoras.de.

For more options, visit https://groups.google.com/d/optout.

--

« Je déteste la montagne, ça cache le paysage »
Alphonse Allais

[Nils Kilden-Pedersen]

On Sat, Jun 20, 2015 at 2:52 PM, iulian dragos <jagu...@gmail.com> wrote:

There's a template for each class/trait/object wizard. If you go to Preferences/Editor/Templates you will see a number of templates starting with `wizard_`. Edit them to remove the scaladoc.

Great, thanks!

 

On Sat, Jun 20, 2015 at 10:13 AM, Simon Schäfer <ma...@antoras.de> wrote:

On 06/20/2015 07:32 AM, Nils Kilden-Pedersen wrote:

How do I disable Scaladoc auto-generation when creating a new class?

I don't understand, what do you mean by Scaladoc auto-generation? What exactly do you see/What exactly happens?

--
You received this message because you are subscribed to the Google Groups "Scala IDE User" group.
To unsubscribe from this group and stop receiving emails from it, send an email to scala-ide-use...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/scala-ide-user/CABDULvXQyDT0sN%3DR%2BMMafLXrct50kAFN-aepVmn4uJ1k8tDxvA%40mail.gmail.com.
For more options, visit https://groups.google.com/d/optout.

--
You received this message because you are subscribed to the Google Groups "Scala IDE User" group.
To unsubscribe from this group and stop receiving emails from it, send an email to scala-ide-use...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/scala-ide-user/5585208C.4090203%40antoras.de.

For more options, visit https://groups.google.com/d/optout.

--

« Je déteste la montagne, ça cache le paysage »
Alphonse Allais

--
You received this message because you are subscribed to the Google Groups "Scala IDE User" group.
To unsubscribe from this group and stop receiving emails from it, send an email to scala-ide-use...@googlegroups.com.

To view this discussion on the web visit https://groups.google.com/d/msgid/scala-ide-user/CAOwe9fbkDhSO2uF8aK8x-gGaRzDYV65WhPqA753irfofv6%2BJJA%40mail.gmail.com.

[Mirco Dotta]

I was also extremely annoyed by them (until I turned them off), and I believe this is something relatively new (it was introduced in 4.0, wasn’t it?).

Personally, I’d vote for disabling these new template wizards and restore the pre-4.0 behaviour. Please, don’t get me wrong, I’m not saying the template wizards are not useful. I’m sure they are, but I personally don’t need them. Furthermore, if I’d need them, I’d change the generated text , which is why I think having the template wizard disabled is a sensible default (as it would be easy to enable the feature while editing the generated text).

If there is consensus, I can provide the PR (should be a super easy one ;-)).

— Mirco

----------------

Mirco Dotta - @mircodotta

Typesafe – Build reactive apps!

To view this discussion on the web visit https://groups.google.com/d/msgid/scala-ide-user/CABDULvVEw%3DLjdYUd8tq6iNeN16Riagiph0Cpxzt66mMWB3a9%3DA%40mail.gmail.com.

[Simon Schäfer]

On 06/22/2015 05:13 PM, Mirco Dotta wrote:

I was also extremely annoyed by them (until I turned them off), and I believe this is something relatively new (it was introduced in 4.0, wasn’t it?).

Personally, I’d vote for disabling these new template wizards and restore the pre-4.0 behaviour. Please, don’t get me wrong, I’m not saying the template wizards are not useful. I’m sure they are, but I personally don’t need them. Furthermore, if I’d need them, I’d change the generated text , which is why I think having the template wizard disabled is a sensible default (as it would be easy to enable the feature while editing the generated text).

If you think it is better default behavior to not automatically generate the Scaladoc comments at the top, feel free to send a PR that removes them from the templates. I'm not in favor of anything here, given that I don't have any data about what people want (beside from some people complaining that they don't want these comments). What you mean by "I don't need them" is not clear to me because they are not doing anything beside from generating a small snippet of code, which you can freely edit anyway.

To view this discussion on the web visit https://groups.google.com/d/msgid/scala-ide-user/0AF0A5F7-2725-4C5E-B940-E10608F66539%40typesafe.com.

[Mirco Dotta]

----------------

Mirco Dotta - @mircodotta

Typesafe – Build reactive apps!

On 22 Jun 2015, at 17:55, Simon Schäfer <ma...@antoras.de> wrote:

On 06/22/2015 05:13 PM, Mirco Dotta wrote:

I was also extremely annoyed by them (until I turned them off), and I believe this is something relatively new (it was introduced in 4.0, wasn’t it?).

Personally, I’d vote for disabling these new template wizards and restore the pre-4.0 behaviour. Please, don’t get me wrong, I’m not saying the template wizards are not useful. I’m sure they are, but I personally don’t need them. Furthermore, if I’d need them, I’d change the generated text , which is why I think having the template wizard disabled is a sensible default (as it would be easy to enable the feature while editing the generated text).

If you think it is better default behavior to not automatically generate the Scaladoc comments at the top, feel free to send a PR that removes them from the templates. I'm not in favor of anything here, given that I don't have any data about what people want (beside from some people complaining that they don't want these comments).

True, I also have no real data but myself :-) However, also the JDT doesn’t inject any javadoc when creating a new source (this doesn’t really add match to my argument, but I thought it could be useful to point it out).

What you mean by "I don't need them" is not clear to me because they are not doing anything beside from generating a small snippet of code, which you can freely edit anyway.

Right, but I need to edit them every time, which clearly bothers me. The solution is disabling them, which I can do if I know the option exist. The reason why I’m suggesting disabling it by default is because I’m afraid many would not easily find out how to disable the feature, causing quite a bit of frustration to the ones that really do not want to have the extra comments added to every new source file.

You received this message because you are subscribed to the Google Groups "Scala IDE Dev" group.
To unsubscribe from this group and stop receiving emails from it, send an email to scala-ide-de...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/scala-ide-dev/5588300B.5050303%40antoras.de.

[Simon Schäfer]

Fix available: https://github.com/scala-ide/scala-ide/pull/973

To view this discussion on the web visit https://groups.google.com/d/msgid/scala-ide-dev/4C2D2E1B-6877-4D57-A214-BA9B177DE7BD%40typesafe.com.