IntelliJ Copyright Configuration: Difference between revisions

From NovaOrdis Knowledge Base
Jump to navigation Jump to search
(Created page with "=Internal= * IntelliJ Configuration")
 
No edit summary
 
(13 intermediate revisions by the same user not shown)
Line 1: Line 1:
=External=
* https://www.jetbrains.com/idea/help/generating-and-updating-copyright-notice.html
* https://www.jetbrains.com/idea/help/copyright-profiles.html
=Internal=
=Internal=


* [[IntelliJ#Configuration|IntelliJ Configuration]]
* [[IntelliJ#Configuration|IntelliJ Configuration]]
=Overview=
This procedure can be used to configure a project so all its files are created by default with a Copyright notice. The procedure must be repeated for any project.
=Make Sure the Copyright Plugin is Installed=
Preferences -> Plugins. It should be in the list.
=Create a Copyright Profile=
Create a copyright profile.
IntelliJ IDEA upper menu entry -> Preferences -> Editor -> Copyright -> Copyright Profiles -> +
Apache 2.0
Name: Apache 2.0
Copyright text:
Example of an Apache 2.0 copyright text:
<pre>
Copyright (c) $today.year Nova Ordis LLC
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
  http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
</pre>
If you used Velocity template elements, "Validate" the template.
Keyword to detect copyright in comments: Copyright.
OK.
=Configure the Project so all its Files Are Created with a Copyright Notice=
Select a project file.
Control + Enter -> Generate -> Copyright
"No Copyright Available. No copyright configured for current file. Would you like to edit copyright settings?" -> OK
It goes to Preferences -> Editor -> Copyright
In the right pane: Default project copyright. The drop down menu should contain "Apache 2.0". Select.
In the Scope pane: + -> Project Files -> OK.

Latest revision as of 21:13, 21 January 2016

External

Internal

Overview

This procedure can be used to configure a project so all its files are created by default with a Copyright notice. The procedure must be repeated for any project.

Make Sure the Copyright Plugin is Installed

Preferences -> Plugins. It should be in the list.

Create a Copyright Profile

Create a copyright profile.

IntelliJ IDEA upper menu entry -> Preferences -> Editor -> Copyright -> Copyright Profiles -> +

Apache 2.0

Name: Apache 2.0

Copyright text:

Example of an Apache 2.0 copyright text:

Copyright (c) $today.year Nova Ordis LLC

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

If you used Velocity template elements, "Validate" the template.

Keyword to detect copyright in comments: Copyright.

OK.

Configure the Project so all its Files Are Created with a Copyright Notice

Select a project file.

Control + Enter -> Generate -> Copyright

"No Copyright Available. No copyright configured for current file. Would you like to edit copyright settings?" -> OK

It goes to Preferences -> Editor -> Copyright

In the right pane: Default project copyright. The drop down menu should contain "Apache 2.0". Select.

In the Scope pane: + -> Project Files -> OK.