Gregory Nutt
611aa8b998
Documentation/NuttXCCodingStandard.html: Fix description of comments on the right.
...
Documentation/NuttXCCodingStandard.html:
- Fix a typo: "be aligned so that the comment begins in the same comment on each line." Of course that should have been column.
- Update a coding standard requirement. With regard to Comments to the Right of Statements, the document said: "If such comments are used, they should ... fit on one line." This is not true any more. In common practice (include the checks in nxstyle), comments to the right of statements may be continued in the following line. The standard way of continuing such comments was also documented.
In this case the coding standard actually contradicted iteself since first it says the that the comments to the right must fit on one line, but later illustrates (without description) how to continue a long right hand comment on the following line.
Documents/style.css: It appears that a variable width font was being used for <pre> and <code>, that was really screwing up the presentation, especially in the coding standared where there are many examples illustrating correct vertical alignment. The font type "Bitstream Vera Sans Mono" was replaced with "courier" for <pre> and <code>
2020-05-20 11:19:24 +08:00
Xiang Xiao
cde88cabcc
Run codespell -w with the latest dictonary again
...
Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2020-02-23 22:27:46 +01:00
Xiang Xiao
bd4e8e19d3
Run codespell -w against all files
...
and fix the wrong correction
2020-02-22 14:45:07 -06:00
Gregory Nutt
18325867bb
Documentation/NuttXCCodingStandard.html: Update license information
...
* Change required license for new files from BSD to Apache 2.0
* Update source file templates to use Apache 2.0 license vs. the BSD license.
2020-02-02 07:36:34 -08:00
Gregory Nutt
06c2e86d98
Documentation/NuttXCCodingStandard.html: Remove requirement to decorate ignored returned values with (void). ( #31 )
...
Co-authored-by: Gregory Nutt <gnutt@nuttx.org>
2020-01-03 09:55:10 -03:00
Gregory Nutt
9be93c710a
Documentation/NuttXCCodingStandard.html: Another small change discouraging the practice of enclosing the value argument of 'return' statements in parentheses.
2019-07-06 13:08:27 -06:00
Gregory Nutt
ea44bc5691
Documentation/NuttXCCodingStandard.html: Update requirements for indenting C pre-processor statements.
2019-07-05 10:46:07 -06:00
Gregory Nutt
51d6ad2ffe
Documentation/NuttXCCodingStandard.html: Yet another small addition to the C++ coding standard overview.
2019-06-05 16:22:09 -06:00
Gregory Nutt
ac8a3c40a8
Documentation/NuttXCCodingStandard.html: A few more additions to the previous commit.
2019-06-05 16:18:45 -06:00
Gregory Nutt
7eab088dd4
Documentation/NuttXCCodingStandard.html: Add a brief section summarizing the major differences between the NuttX C and C++ coding standards. This is a stop-gap measure in lieu of having a real C++ coding standard.
2019-06-05 15:38:35 -06:00
Matias N
272b5b2636
Documentation/: Applies a stylesheet to static HTML files. I've also tried to put the TOC of each document to the side, where it made sense (in some documents the TOC was actually inside a section so it wasn't possible). In some cases the TOC is built with a table, in others with a <ul> element, so I had to acomodate for this. I also didn't go into collapsing, although this could really help for some long TOCs.
2019-05-21 19:13:45 -06:00
Gregory Nutt
f9f6de5ba0
Documentation/NuttXCCodingStandard.html: Minor updates pointing out some similarities to the GNU coding standard.
2019-02-05 16:54:36 -06:00
Gregory Nutt
c98309db84
Fix some typos in TODO and C coding standard document.
2019-01-11 08:57:35 -06:00
Gregory Nutt
44d6ce5785
Documentation/NuttXCCodingStandard.html: Correct discussion of properties of indentation levels.
2019-01-10 11:27:13 -06:00
Gregory Nutt
21d2dfc80b
Trivial update to coding standard document.
2018-10-21 17:21:52 -06:00
Gregory Nutt
84ede4a25a
Minor update to the coding standing.
2018-08-28 18:15:23 -06:00
Gregory Nutt
c9792c74f7
Trivial change to Coding Standard document.
2018-08-22 06:03:56 -06:00
Gregory Nutt
993888fc97
Another tiny update to the coding standard just to make a point a little clearer.
2018-08-21 15:30:50 -06:00
Gregory Nutt
07ef3fe018
Another update to the coding standard; Add some comments detailing the POSIX non-compliance in include/signal.h
2018-08-21 15:27:37 -06:00
Gregory Nutt
30d7dbd9a6
Update C Coding standard again. Correct some comments in tools/nxstyle.c
2018-08-21 13:32:05 -06:00
Gregory Nutt
b0d8a2d31f
Update C coding standard.
2018-08-21 12:56:36 -06:00
Gregory Nutt
f12f2c3828
Documentation: Use a little more care with the trademarked Unix name.
2018-05-11 08:15:51 -06:00
Gregory Nutt
d5c91f9a57
C Coding Standard: Clarify the form of structures and unions declared with local variable definition.
2017-08-07 16:28:10 -06:00
Gregory Nutt
de6999ad88
Update coding standard (with some other misc. changes to procfs strings)
2017-06-18 15:52:50 -06:00
Gregory Nutt
40f60d6da5
Update to coding standard document and to a README file.
2017-06-11 10:01:14 -06:00
Gregory Nutt
39d222ebcb
Update Coding Standard Document.
2017-06-09 11:34:01 -06:00
Gregory Nutt
d1f69822d8
Update Coding Standard Document.
2017-06-09 11:02:08 -06:00
Gregory Nutt
e4b71a06bb
Update the C coding standard.
2017-05-06 15:20:25 -06:00
Gregory Nutt
d9c266c71b
Trivial change to document.
2017-04-19 06:23:13 -06:00
Gregory Nutt
e7a1847d08
Coding style: Minor updates to last commit.
2017-04-18 16:46:23 -06:00
Gregory Nutt
0a457a1b20
Coding standard: Defining structures within the scope of another structure is discouraged.
2017-04-18 16:29:49 -06:00
Gregory Nutt
13e3e79183
Update coding standard document to discuss un-named structure fields.
2017-04-17 13:17:35 -06:00
Gregory Nutt
085dcf92e3
Update Coding Standard and some Kconfig comments.
2017-02-09 12:57:44 -06:00
Gregory Nutt
4f22af9547
Grrr.. fix another typo.
2016-08-24 13:20:46 -06:00
Gregory Nutt
4c045d3fcd
Fix an error in the 'Prefferred' example
2016-08-24 13:17:57 -06:00
Gregory Nutt
909486da47
Update to NuttX C coding style document with additions discussing long comments on the right side of a statement or data definition.
2016-08-24 13:07:40 -06:00
OrbitalFox
78a2465af4
SAM4E: Fix some errors in AFEC header file.
2016-06-10 09:56:35 -06:00
Gregory Nutt
c98f00a93b
Update comments; trivial addtion to a document.
2016-06-10 09:36:59 -06:00
Gregory Nutt
1b53c9dd33
Fix some HTML errors
2016-03-14 14:51:29 -06:00
Gregory Nutt
e9d116ef14
Coding Standard: Add TAB stop requirement
2015-12-29 13:36:26 -06:00
Gregory Nutt
86bf4c6193
More ipdates to coding style
2015-07-28 20:34:16 -06:00
Gregory Nutt
02afdddebe
Update coding style
2015-07-28 20:17:19 -06:00
Gregory Nutt
d7db55cf67
Documentation: Update all images. I think they were all damaged by a wild in place sed in some recent change
2014-07-13 15:54:13 -06:00
Gregory Nutt
e02f1ba37a
Fix some recurring typos: postion->position, *atino->*ation
2014-07-08 13:12:36 -06:00
Gregory Nutt
79511f427f
Fix some cloned errors in SAM GPIO interrupt setup
2014-07-07 15:54:37 -06:00
Gregory Nutt
aaaf4f96b7
More trailing whilespace removal
2014-04-13 16:22:22 -06:00
Gregory Nutt
ff13e4b75a
Add support for TM4C GPIOs
2014-03-10 08:12:35 -06:00
Gregory Nutt
10ed104c03
Add a coding standards document
2014-02-06 13:48:07 -06:00