Main Page
The C++ Wiki
The Narwhal bacons at midnight!
Contents |
It's a new Wiki
The C++ Wiki is just getting started. Anyone who wants to be a main contributor, please read the Structure and Style Guide then just get started. If you add a couple of well formatted pages we'll set you up with an elevated privilege account and if you want, have a say in running this site. Because at the moment we could use some help making this an actual wiki!
Plans for the Wiki
The plan for C++ wiki is to document the Standard C Library and the Standard C++ Library. We want create a valuable reference with good documentation standards so that both new programmers and old pros will find it equally useful. To achive this we want to add a Code Snippit Section to the bottom of certain pages so people can show there own examples of there usage for that function, datatype, class, or macro.
More Libraries
We will be willing to add some common crossplatform libraries from outside of the C standards, possably SDL. or maybe just add a link page to external references.
Compilers
It would also be nice to include a list of common compilers. And maybe pages on how to setup and compile with some common librarys. External links welcome.
Wiki Structure and Style Guide
The plan for C++ wiki is to document the Standard C Library and the Standard C++ Library. The structure for name articles is as follows:
Standard C Library
- Standard C Library pages should be titled Cstdlib<space><header file or function name>.
Headers
- See Cstdlib:Time.h for a basic outline.
- Titled Cstdlib<colon><header file name> eg "Cstdlib:Time.h"
- Header files should include a table for functions, macros and types.
- The tables should link to each function, macro and type.
- Commonly Used Headers:
1.cassert(assert.h) C Diagnostics Library (header)
2.cctype(ctype.h) Character handling functions (header)
3.cerrno(errno.h) C Errors (header)
4.cfloat(float.h) Characteristics of floating-point types (header)
5.ciso646(iso646.h) ISO 646 Alternative operator spellings (header)
6.climits(limits.h) Sizes of integral types (header)
7.clocale(locale.h) C localization library (header)
8.cmath(math.h) C numerics library (header)
9.csetjmp(setjmp.h) Non local jumps (header)
10.csignal(signal.h) C library to handle signals (header)
11.cstdarg(stdarg.h) Variable arguments handling (header)
12.cstddef(stddef.h) C Standard definitions (header)
13.cstdio(stdio.h) C library to perform Input/Output operations (header)
14.cstdlib(stdlib.h) C Standard General Utilities Library (header)
15.cstring(string.h) C Strings (header)
16.ctime C Time Library (header)
Functions
- Titled Cstdlib<colon><header file><colon><fucntion name> eg Cstdlib:stdio.h:gets .
- First a short descryption of the function.
- One section for EACH parameter(specifing data type).
- One Section for the return value(specifing data type).
- A short example code for common usage.
- Example code for a common defenition of the function eg source of gets() .
