IntelliJ Copyright Configuration: Difference between revisions

From NovaOrdis Knowledge Base
Jump to navigation Jump to search
No edit summary
No edit summary
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
=External=
=External=


* https://www.jetbrains.com/idea/help/generating-and-updating-copyright-notice.html
* https://www.jetbrains.com/idea/help/copyright-profiles.html
* https://www.jetbrains.com/idea/help/copyright-profiles.html


Line 7: Line 8:
* [[IntelliJ#Configuration|IntelliJ Configuration]]
* [[IntelliJ#Configuration|IntelliJ Configuration]]


=Overview=


=Assign Copyright Notice to Project Files=
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.
 
In a project file (java class file), press Control + Enter then select "Copyright" from the contextual menu.
 
"No Copyright Available. No copyright configured for current file. Would you like to edit copyright settings?" -> OK
 
It goes to Preferences -> Editor -> Copyright


=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 -> +  
 
 
 
 
 
=Create a Copyright Profile=
 
Create a copyright profile. File -> Other Settings -> Default Settings -> Editor -> Copyright -> Copyright Profiles -> +  


Apache 2.0
Apache 2.0
Line 54: Line 46:
</pre>
</pre>


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


Keyword to detect copyright in comments: Copyright.
Keyword to detect copyright in comments: Copyright.


=Apply the Copyright Profile to an Entire Project=
OK.


Select the project.
=Configure the Project so all its Files Are Created with a Copyright Notice=


Then File ->  Other Settings -> Default Settings.
Select a project file.


Go to "Editor" and click on "Copyright". Do not expand.
Control + Enter -> Generate -> Copyright


In the right window you'll see: "Editor > Copyright > For default project"
"No Copyright Available. No copyright configured for current file. Would you like to edit copyright settings?" -> OK


From "Default project copyright" drop-down menu select the desired copyright ("Apache 2.0").
It goes to Preferences -> Editor -> Copyright
 
Scope -> + Project Files.
 
Apply.


=Insert the Copyright Notice into a Specific File=
In the right pane: Default project copyright. The drop down menu should contain "Apache 2.0". Select.


Control + Enter -> Copyright -> Assign the Copyright profile to the project.
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.