-
Notifications
You must be signed in to change notification settings - Fork 61
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
*.md: Change toplevel documentation to asciidoc. RNS-1131
- Loading branch information
Christopher Alfeld
committed
Jul 18, 2014
1 parent
9897e45
commit 6a84d08
Showing
8 changed files
with
356 additions
and
381 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,105 @@ | ||
| //// | ||
| This file is intended to be read in HTML via translation with asciidoc. | ||
| //// | ||
|
|
||
| = IronBee Development | ||
|
|
||
| == Introduction | ||
|
|
||
| This document describes the coding style used in IronBee. This guide is intended to be just that, a guide, not a strict dictation of code styling rules. However, if there is doubt this guide is authoritative. | ||
|
|
||
| Generally the IronBee project follows the Apache Httpd coding style. This style is located here: http://httpd.apache.org/dev/styleguide.html | ||
|
|
||
| Note that this guide is generally for C source, but should also be used where applicable for C++ and other languages. | ||
|
|
||
| == General Style | ||
|
|
||
| Generally this style is as follows (taken from the Apache guide): | ||
|
|
||
| * Indention is with 4 spaces and no TABs. | ||
|
|
||
| * Opening braces are given on the same lines as statements, or on the following line at the start of a function definition. | ||
|
|
||
| * Code inside a block (whether surrounded by braces or not) is indented by four space characters. Tab characters are not used. Comments are indented to the same level as the surrounding code. | ||
|
|
||
| * Closing braces are always on a separate line from surrounding code, and are indented to line up with the start of the text on the line containing the corresponding opening brace. | ||
|
|
||
| * Functions are declared with ANSI-style arguments. | ||
|
|
||
| * There is no space between the function name and the opening bracket of the arguments to the function. There is a single space following commas in argument lists and the semi-colons in for statements. | ||
|
|
||
| * Inside a +switch+ statement, the +case+ keywords are indented to the same level as the switch line. | ||
|
|
||
| * Operators in expressions should be surrounded by a single space before and after, except for unary increment (`++`), decrement (+--+), and negation (+!+) operators. | ||
|
|
||
| * There is no whitespace between a cast and the item modified (e.g., +(int)j+ and not +(int) j+). | ||
|
|
||
| * If a cast is to a pointer type, there is a space between the type and the * character (e.g., +(char *)i+ instead of +(char*)i1) | ||
|
|
||
| Code formatted with GNU indent should also be acceptable with the following options (as in the Apache style): | ||
|
|
||
| ---- | ||
| -i4 -npsl -di0 -br -nce -d0 -cli0 -npcs -nfc1 -nut | ||
| ---- | ||
|
|
||
| == Additions to Coding Style | ||
|
|
||
| The following describes additions to the above coding style which are not directly related to code formatting. | ||
|
|
||
| * All source files must have a license/copyright banner such as follows: | ||
|
|
||
| ---- | ||
| /***************************************************************************** | ||
| * Licensed to Qualys, Inc. (QUALYS) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * QUALYS licenses this file to You under the Apache License, Version 2.0 | ||
| * (the "License"); you may not use this file except in compliance with | ||
| * the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| ****************************************************************************/ | ||
| ---- | ||
|
|
||
| * All source files MUST have a doxygen block such as follows: | ||
|
|
||
| ---- | ||
| /** | ||
| * @file | ||
| * @brief IronBee --- SubTitle | ||
| * | ||
| * Some description here. | ||
| * | ||
| * @author Author One <author1@company.com> | ||
| * @author Author Two <author2@company.com> | ||
| */ | ||
| ---- | ||
|
|
||
| * All public functions MUST include doxygen documentation such as follows. | ||
| This documentation MUST be in the public header file. | ||
|
|
||
| ---- | ||
| /** | ||
| * Some brief description. | ||
| * | ||
| * Some more detailed description. | ||
| * | ||
| * @param[in] p1 Parameter 1 description | ||
| * @param[in] p1 Parameter 2 description | ||
| * @param[out] p3 Address which blah is written | ||
| * | ||
| * @returns Status code | ||
| */ | ||
| ---- | ||
|
|
||
| * All private functions SHOULD have doxygen documentation such as above. Any doxygen documentation in +.c+ or +_private.h+ files is automatically treated as private. If a private function must be in a public header file surround it and the code in question with +@cond internal+ and +@endcond internal+. | ||
|
|
||
| * All callbacks MUST support callback data. Callback data is a +void *+ that is provided with the function pointer at registration and is passed as the _last_ argument to the callback function. It is important that it is the last argument as this consistency allows easy trampoline creation (see +include/ironbeepp/c_trampoline.hpp+). | ||
|
|
||
| * +void **+ is not allowed as a parameter type. Use +void *+ for any generic pointer parameter and clearly document any requirements on its use such as the level of indirection. |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.