Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update license heading for all source files. #154

Closed
jeandudey opened this issue May 14, 2020 · 2 comments · Fixed by #157
Closed

Update license heading for all source files. #154

jeandudey opened this issue May 14, 2020 · 2 comments · Fixed by #157
Labels
Type: documentation Improvements or additions to documentation

Comments

@jeandudey
Copy link
Member

We currently use the Apache-2.0 license, and it requires to have on each source file a reference to the license in use, in our case Apache-2.0.

/**
 * Copyright 2020 btcven and Locha Mesh developers
 *
 * 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.
 */

/**
 * @{
 *
 * @file
 * @brief         Dictatorship mandatory code
 *
 * @author        Nicolás Maduro <eldictadorprograma@presidencia.com.ve>
 * @}
 */

This is an example of how each file should have their license and the respective documentation comment containing the @file which should be blank, author and a brief description of what the file does. Ideally the author is the one who created the code so when someone modifies it one can know immediately who wrote it and who to ask in case of the need to understand something.

@jeandudey jeandudey added the Type: documentation Improvements or additions to documentation label May 14, 2020
@luisan00 luisan00 linked a pull request May 20, 2020 that will close this issue
@luisan00
Copy link
Member

linked with PR #157

xkevin190 added a commit that referenced this issue May 20, 2020
Update license heading for all source files this closes #154
@jeandudey
Copy link
Member Author

This is fixed now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants