You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@nuttx.apache.org by Nathan Hartman <ha...@gmail.com> on 2020/04/26 22:31:00 UTC

Where in file header to put short description?

Previously at some point, we discussed optionally putting a short (one
line) description of a file's purpose somewhere in or near the Apache
header. Where did we decide to put that (if we decided)?

Thanks,
Nathan

Re: Where in file header to put short description?

Posted by Nathan Hartman <ha...@gmail.com>.
On Sun, Apr 26, 2020 at 6:32 PM Gregory Nutt <sp...@gmail.com> wrote:

>
> > Previously at some point, we discussed optionally putting a short (one
> > line) description of a file's purpose somewhere in or near the Apache
> > header. Where did we decide to put that (if we decided)?
> >
> > Thanks,
> > Nathan
>
>
> https://cwiki.apache.org/confluence/display/NUTTX/Coding+Standard#fileorganization
>
>
> https://cwiki.apache.org/confluence/display/NUTTX/Coding+Standard#cfilestructure
>
>
Looks like not only did we discuss and decide, we documented it! Thanks for
replying and your patience with dumb questions:-)

Nathan

Re: Where in file header to put short description?

Posted by Gregory Nutt <sp...@gmail.com>.

> Previously at some point, we discussed optionally putting a short (one
> line) description of a file's purpose somewhere in or near the Apache
> header. Where did we decide to put that (if we decided)?
>
> Thanks,
> Nathan

https://cwiki.apache.org/confluence/display/NUTTX/Coding+Standard#fileorganization

https://cwiki.apache.org/confluence/display/NUTTX/Coding+Standard#cfilestructure