Commit Graph

15 Commits

Author SHA1 Message Date
0xflotus 5253444090
docs: enable syntax highlighting in several docs files
... for better readability

Closes #6286
2020-12-11 18:06:41 +01:00
Daniel Stenberg 8df455479f
source cleanup: remove all custom typedef structs
- Stick to a single unified way to use structs
 - Make checksrc complain on 'typedef struct {'
 - Allow them in tests, public headers and examples

 - Let MD4_CTX, MD5_CTX, and SHA256_CTX typedefs remain as they actually
   typedef different types/structs depending on build conditions.

Closes #5338
2020-05-15 08:54:42 +02:00
Viktor Szakats f3e0f071b1 docs: Markdown and misc improvements [ci skip]
Approved-by: Daniel Stenberg
Closes #3896
2019-05-16 22:11:27 +00:00
Daniel Stenberg 07b9826541
CODE_STYLE: mention return w/o parens, but sizeof with
... and remove the github markdown syntax so that it renders better on
the web site. Also, don't use back-ticks inlined to allow the CSS to
highlight source code better.
2018-05-14 10:47:59 +02:00
Daniel Stenberg 1299df6868 CODE_STYLE.md: link to INTERNALS.md correctly 2016-11-09 09:56:13 +01:00
Daniel Stenberg 0f1996321f s/cURL/curl
The tool was never called cURL, only the project. But even so, we have
more and more over time switched to just use lower case.
2016-10-18 13:59:54 +02:00
Jay Satiro 511838f1d8 CODE_STYLE: fix long-line guideline
- Change maximum allowed line length from 80 to 79.
2016-09-12 01:51:37 -04:00
Jay Satiro 27c2131b02 CODE_STYLE: add column alignment section
Note that since the added examples are for column alignment I had to
encapsulate with ~~~c markdown to preserve their alignment.
2016-09-11 19:12:14 -04:00
Steve Holme 9b03bca6e6 CODE_STYLE: Added ternary operator example to 'Space around operators'
Following conversation on the libcurl mailing list.
2016-04-09 17:04:46 +01:00
Daniel Stenberg a136cdeaf1 CODE_STYLE: indend example code
... to make it look nicer in markdown outputa
2016-03-22 08:36:21 +01:00
Steve Holme eba1b3099f CODE_STYLE: Use boolean conditions
Rather than use TRUE, FALSE, NULL, 0 or != 0 in if/while conditions.

Additionally, corrected some example code to adhere to the recommended
coding style.
2016-03-20 11:51:11 +00:00
Daniel Stenberg 0fc73d364e CODE_STYLE: Space around operators
As just discussed on the mailing list, also document how we prefer
spacing in expressions.
2016-03-14 14:31:14 +01:00
Daniel Stenberg 2ad3cf2fba CODE_STYLE: add example for indent style as well 2016-03-14 10:40:02 +01:00
Daniel Stenberg c5c7a3e40f CODE_STYLE: mention braces for functions too 2016-03-14 10:36:51 +01:00
Daniel Stenberg 303bf719ff CODE_STYLE: initial version
Ripped out from CONTRIBUTE into its own document, but also extended from
there.
2016-03-14 10:28:54 +01:00