Difference between revisions of "Source file headers"
From ElphelWiki
(Created page with "==*.c== ====GPL-2.0+==== /* ******************************************************************************** * @file FILENAME * @brief Interface to FPGA-based command se...") |
(→*.py) |
||
| (21 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| + | ==*.php== | ||
| + | ====GPL-3.0+==== | ||
| + | /** | ||
| + | * @file FILENAME | ||
| + | * @brief BRIEF DESCRIPTION | ||
| + | * @copyright Copyright (C) YEAR Elphel Inc. | ||
| + | * @author AUTHOR <EMAIL> | ||
| + | * | ||
| + | * @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/>. | ||
| + | */ | ||
| + | * <font color='red'>'''NOTE: for LibreJS (if turned on in Firefox) if php response is a plain text before printing output add:'''</font> | ||
| + | header("Content-Type: text/plain"); | ||
| + | |||
| + | ==*.py== | ||
| + | ====GPL-3.0+==== | ||
| + | * <font color='red'>'''NOTE: duplicated fields'''</font> | ||
| + | <nowiki>'''</nowiki> | ||
| + | /** | ||
| + | * @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" | ||
| + | __copyright__ = "Copyright (C) YEAR Elphel Inc." | ||
| + | __license__ = "GPLv3+" | ||
| + | __version__ = "1.0" | ||
| + | __maintainer__ = "MAINTAINER" | ||
| + | __email__ = "EMAIL" | ||
| + | __status__ = "STATUS" | ||
| + | |||
| + | ==*.js== | ||
| + | ====GPL-3.0+==== | ||
| + | * <font color='red'>'''Note: sometimes LibreJS (if the plugin is turned on in Firefox) can fail to parse exteranl js file - ignore'''</font> | ||
| + | /** | ||
| + | * @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. | ||
| + | */ | ||
| + | |||
| + | ==*.html== | ||
| + | ====GPL-3.0+ (for embedded javascript)==== | ||
| + | * <font color='red'>'''NOTE: can be placed within: <head>...</head>'''</font> | ||
| + | <script> | ||
| + | /** | ||
| + | * @file FILENAME | ||
| + | * @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. | ||
| + | */ | ||
| + | </script> | ||
| + | |||
| + | ==*.css== | ||
| + | - | ||
| + | |||
==*.c== | ==*.c== | ||
| − | ====GPL-2.0+==== | + | ====GPL-2.0+ (for kernel only)==== |
| − | / | + | /** |
| − | + | * @file FILENAME | |
| − | * @file | + | * @brief BRIEF DESCRIPTION |
| − | * @brief | + | * @copyright Copyright (C) YEAR Elphel Inc. |
| − | * @copyright Copyright | ||
* @author AUTHOR <EMAIL> | * @author AUTHOR <EMAIL> | ||
| − | * @par | + | * |
| + | * @par <b>License</b>: | ||
* This program is free software: you can redistribute it and/or modify | * 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 | * it under the terms of the GNU General Public License as published by | ||
* 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 | ||
| + | * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
| + | */ | ||
| + | ====GPL-3.0+==== | ||
| + | /** | ||
| + | * @file FILENAME | ||
| + | * @brief BRIEF DESCRIPTION | ||
| + | * @copyright Copyright (C) YEAR Elphel Inc. | ||
| + | * @author AUTHOR <EMAIL> | ||
| + | * | ||
| + | * @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 | * 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/>. | ||
| − | |||
*/ | */ | ||
| − | ==*. | + | ==*.v== |
| + | ====GPL-3.0+==== | ||
| + | * <font color='red'>'''NOTE: FILENAME in 3 places:'''</font> | ||
| + | /*! | ||
| + | * <b>Module:</b> MODULENAME | ||
| + | * @file FILENAME | ||
| + | * @brief BRIEF DESCRIPTION | ||
| + | * @copyright Copyright (C) YEAR Elphel Inc. | ||
| + | * @author AUTHOR <EMAIL> | ||
| + | * @date DATE | ||
| + | * | ||
| + | * @par License: | ||
| + | * FILENAME 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. | ||
| + | * | ||
| + | * FILENAME 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/>. | ||
| + | * | ||
| + | * Additional permission under GNU GPL version 3 section 7: | ||
| + | * If you modify this Program, or any covered work, by linking or combining it | ||
| + | * with independent modules provided by the FPGA vendor only (this permission | ||
| + | * does not extend to any 3-rd party modules, "soft cores" or macros) under | ||
| + | * different license terms solely for the purpose of generating binary "bitstream" | ||
| + | * files and/or simulating the code, the copyright holders of this Program give | ||
| + | * you the right to distribute the covered work without those independent modules | ||
| + | * as long as the source code for them is available from the FPGA vendor free of | ||
| + | * charge, and there is no dependence on any encrypted modules for simulating of | ||
| + | * the combined code. This permission applies to you if the distributed code | ||
| + | * contains all the components and scripts required to completely simulate it | ||
| + | * with at least one of the Free Software programs. | ||
| + | */ | ||
Latest revision as of 14:20, 4 May 2017
Contents
*.php
GPL-3.0+
/** * @file FILENAME * @brief BRIEF DESCRIPTION * @copyright Copyright (C) YEAR Elphel Inc. * @author AUTHOR <EMAIL> * * @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/>. */
- NOTE: for LibreJS (if turned on in Firefox) if php response is a plain text before printing output add:
header("Content-Type: text/plain");
*.py
GPL-3.0+
- NOTE: duplicated fields
''' /** * @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/>. */ ''' __author__ = "AUTHOR" __copyright__ = "Copyright (C) YEAR Elphel Inc." __license__ = "GPLv3+" __version__ = "1.0" __maintainer__ = "MAINTAINER" __email__ = "EMAIL" __status__ = "STATUS"
*.js
GPL-3.0+
- Note: sometimes LibreJS (if the plugin is turned on in Firefox) can fail to parse exteranl js file - ignore
/** * @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. */
*.html
GPL-3.0+ (for embedded javascript)
- NOTE: can be placed within: <head>...</head>
<script> /** * @file FILENAME * @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. */ </script>
*.css
-
*.c
GPL-2.0+ (for kernel only)
/** * @file FILENAME * @brief BRIEF DESCRIPTION * @copyright Copyright (C) YEAR Elphel Inc. * @author AUTHOR <EMAIL> * * @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 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/>. */
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/>. */
*.v
GPL-3.0+
- NOTE: FILENAME in 3 places:
/*! * Module: MODULENAME * @file FILENAME * @brief BRIEF DESCRIPTION * @copyright Copyright (C) YEAR Elphel Inc. * @author AUTHOR <EMAIL> * @date DATE * * @par License: * FILENAME 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. * * FILENAME 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/>. * * Additional permission under GNU GPL version 3 section 7: * If you modify this Program, or any covered work, by linking or combining it * with independent modules provided by the FPGA vendor only (this permission * does not extend to any 3-rd party modules, "soft cores" or macros) under * different license terms solely for the purpose of generating binary "bitstream" * files and/or simulating the code, the copyright holders of this Program give * you the right to distribute the covered work without those independent modules * as long as the source code for them is available from the FPGA vendor free of * charge, and there is no dependence on any encrypted modules for simulating of * the combined code. This permission applies to you if the distributed code * contains all the components and scripts required to completely simulate it * with at least one of the Free Software programs. */
