[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [ft-devel] Documentation guidelines file
From: |
armin |
Subject: |
Re: [ft-devel] Documentation guidelines file |
Date: |
Tue, 28 Aug 2018 22:45:24 +0100 |
> I've attached the `docs/DOCUMENTATION' file (from the draft work at
> https://github.com/nikramakrishnan/freetype-docs/wiki/Documentation-Guidelines-for-The-FreeType-Project).
> This should cover everything needed to understand the basics and the
> markdown formatting of the docs.
Thanks, very informative! :) The only thing missing (if I haven't missed it)
is the fact that apostrophes are used to refer to other parameters of the same
function ... eg:
```
/****** ...
* ...
* @description:
* Uses 'a' to meep 'b'.
* ...
*/
FT_EXPORT( void )
FT_Meep ( A a,
B b );
```
> A few things, such as preference of uppercasing may be added to this
> From a previous thread:
>
>> * Shall we mention that we prefer two spaces after a full stop ending
> a sentence?
Please do, esp. for people who're new to FreeType; I plan to add a whole code
style guide, once the new website is online :) Generally (not always, but very
often true): the more information the better, esp. when well organised :)
>> Ditto for details on uppercasing in section titles (US
>> style, for example `This and That'), how to cite a C function
>> (without trailing parentheses), etc., etc.
Ditto, please do, for the sake of everyone who's new to contributing to FT :)
> Also, I'm not sure about the `forced' line filling to column 71 as seen
> in other files in the `docs' directory.
I don't exactly know what you mean but I'm sure this one is targeted towards
Werner, who will know :D