Difference between revisions of "Source file headers"
From ElphelWiki
| Line 1: | Line 1: | ||
==*.c== | ==*.c== | ||
====GPL-2.0+==== | ====GPL-2.0+==== | ||
| − | / | + | /** |
| − | |||
* @file FILENAME | * @file FILENAME | ||
* @brief BRIEF DESCRIPTION | * @brief BRIEF DESCRIPTION | ||
| − | * @copyright Copyright (C) YEAR Elphel | + | * @copyright Copyright (C) YEAR Elphel Inc. |
* @author AUTHOR <EMAIL> | * @author AUTHOR <EMAIL> | ||
* | * | ||
| Line 13: | Line 12: | ||
* the Free Software Foundation, either version 2 of the License, or | * the Free Software Foundation, either version 2 of the License, or | ||
* (at your option) any later version. | * (at your option) any later version. | ||
| + | * | ||
* This program is distributed in the hope that it will be useful, | * This program is distributed in the hope that it will be useful, | ||
* but WITHOUT ANY WARRANTY; without even the implied warranty of | * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
* GNU General Public License for more details. | * GNU General Public License for more details. | ||
| + | * | ||
* You should have received a copy of the GNU General Public License | * You should have received a copy of the GNU General Public License | ||
* along with this program. If not, see <http://www.gnu.org/licenses/>. | * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
| − | |||
*/ | */ | ||
| Line 27: | Line 27: | ||
* @file FILENAME | * @file FILENAME | ||
* @brief BRIEF DESCRIPTION | * @brief BRIEF DESCRIPTION | ||
| − | * @copyright Copyright (C) YEAR Elphel | + | * @copyright Copyright (C) YEAR Elphel Inc. |
* @author AUTHOR <EMAIL> | * @author AUTHOR <EMAIL> | ||
* | * | ||
| Line 47: | Line 47: | ||
==*.py== | ==*.py== | ||
====GPL-3.0+==== | ====GPL-3.0+==== | ||
| − | ''' | + | <nowiki>'''</nowiki> |
| − | @file FILENAME | + | /** |
| − | + | * @file FILENAME | |
| − | + | * @brief BRIEF DESCRIPTION | |
| − | + | * @copyright Copyright (C) YEAR Elphel Inc. | |
| − | + | * @author AUTHOR <EMAIL> | |
| − | + | * @deffield updated: Updated | |
| − | + | * | |
| − | + | * @par <b>License</b> | |
| − | + | * This program is free software: you can redistribute it and/or modify | |
| − | + | * it under the terms of the GNU General Public License as published by | |
| − | + | * the Free Software Foundation, either version 3 of the License, or | |
| − | + | * (at your option) any later version. | |
| − | + | * | |
| − | + | * This program is distributed in the hope that it will be useful, | |
| − | + | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| − | + | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| − | + | * GNU General Public License for more details. | |
| − | + | * | |
| − | + | * You should have received a copy of the GNU General Public License | |
| − | ''' | + | * along with this program. If not, see <http://www.gnu.org/licenses/>. |
| + | */ | ||
| + | <nowiki>'''</nowiki> | ||
__author__ = "AUTHOR" | __author__ = "AUTHOR" | ||
| Line 76: | Line 78: | ||
__email__ = "EMAIL" | __email__ = "EMAIL" | ||
__status__ = "STATUS" | __status__ = "STATUS" | ||
| + | |||
| + | ==*.js== | ||
| + | ====GPL-3.0+==== | ||
| + | /** | ||
| + | * @file FILENAME | ||
| + | * @brief BRIEF DESCRIPTION | ||
| + | * @copyright Copyright (C) YEAR Elphel Inc. | ||
| + | * @author AUTHOR <EMAIL> | ||
| + | * | ||
| + | * @licstart The following is the entire license notice for the | ||
| + | * JavaScript code in this page. | ||
| + | * | ||
| + | * The JavaScript code in this page is free software: you can | ||
| + | * redistribute it and/or modify it under the terms of the GNU | ||
| + | * General Public License (GNU GPL) as published by the Free Software | ||
| + | * Foundation, either version 3 of the License, or (at your option) | ||
| + | * any later version. The code is distributed WITHOUT ANY WARRANTY; | ||
| + | * without even the implied warranty of MERCHANTABILITY or FITNESS | ||
| + | * FOR A PARTICULAR PURPOSE. See the GNU GPL for more details. | ||
| + | * | ||
| + | * As additional permission under GNU GPL version 3 section 7, you | ||
| + | * may distribute non-source (e.g., minimized or compacted) forms of | ||
| + | * that code without the copy of the GNU GPL normally required by | ||
| + | * section 4, provided you include this license notice and a URL | ||
| + | * through which recipients can access the Corresponding Source. | ||
| + | * | ||
| + | * @licend The above is the entire license notice | ||
| + | * for the JavaScript code in this page. | ||
| + | */ | ||
Revision as of 11:09, 13 January 2017
*.c
GPL-2.0+
/** * @file FILENAME * @brief BRIEF DESCRIPTION * @copyright Copyright (C) YEAR Elphel Inc. * @author AUTHOR <EMAIL> * * @par License * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 2 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see <http://www.gnu.org/licenses/>. */
*.php
GPL-3.0+
/** * @file FILENAME * @brief BRIEF DESCRIPTION * @copyright Copyright (C) YEAR Elphel Inc. * @author AUTHOR <EMAIL> * * @par License * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see <http://www.gnu.org/licenses/>. */
*.py
GPL-3.0+
''' /** * @file FILENAME * @brief BRIEF DESCRIPTION * @copyright Copyright (C) YEAR Elphel Inc. * @author AUTHOR <EMAIL> * @deffield updated: Updated * * @par License * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see <http://www.gnu.org/licenses/>. */ ''' __author__ = "AUTHOR" __copyright__ = "Copyright (C) YEAR, Elphel, Inc." __license__ = "GPL" __version__ = "3.0+" __maintainer__ = "MAINTAINER" __email__ = "EMAIL" __status__ = "STATUS"
*.js
GPL-3.0+
/** * @file FILENAME * @brief BRIEF DESCRIPTION * @copyright Copyright (C) YEAR Elphel Inc. * @author AUTHOR <EMAIL> * * @licstart The following is the entire license notice for the * JavaScript code in this page. * * The JavaScript code in this page is free software: you can * redistribute it and/or modify it under the terms of the GNU * General Public License (GNU GPL) as published by the Free Software * Foundation, either version 3 of the License, or (at your option) * any later version. The code is distributed WITHOUT ANY WARRANTY; * without even the implied warranty of MERCHANTABILITY or FITNESS * FOR A PARTICULAR PURPOSE. See the GNU GPL for more details. * * As additional permission under GNU GPL version 3 section 7, you * may distribute non-source (e.g., minimized or compacted) forms of * that code without the copy of the GNU GPL normally required by * section 4, provided you include this license notice and a URL * through which recipients can access the Corresponding Source. * * @licend The above is the entire license notice * for the JavaScript code in this page. */
