Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

various: Doxygen fixes.

  • Loading branch information...
commit db56168c56308caf153f9e0333a0014cacd43de0 1 parent d90043f
Christopher Alfeld authored
View
95 CODESTYLE.md
@@ -38,18 +38,18 @@ Generally this style is as follows (taken from the Apache guide):
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
+* 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.
+ 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").
+ (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*)i")
+ 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):
@@ -65,60 +65,55 @@ 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.
- ****************************************************************************/
-```
+ /*****************************************************************************
+ * 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>
- */
-```
+ /**
+ * @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
- */
-```
+ /**
+ * 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'.
+ 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
View
2  configure.ac
@@ -294,7 +294,7 @@ DOXYGEN=$doxygen
DOXYGEN_TOP=`cd $srcdir;pwd`
DOXYGEN_DIRS="include util engine modules automata fast lua predicate example_modules"
-MARKDOWN_DOXYGEN_FILES=`cd $srcdir;find . lua -type f -maxdepth 1 -name '*.md' | grep -v CODESTYLE.md`
+MARKDOWN_DOXYGEN_FILES=`cd $srcdir;find . lua -type f -maxdepth 1 -name '*.md'`
EXTERNAL_DOXYGEN_FILES=`cd $srcdir;find $DOXYGEN_DIRS -type f -name '*.h' -o -name '*.hpp'`
INTERNAL_DOXYGEN_FILES=`cd $srcdir;find $DOXYGEN_DIRS -type f -name '*.h' -o -name '*.hpp' -o -name '*.c' -o -name '*.cpp' -o -name '*.cc'`
DOXYGEN_INPUT=""
View
1  engine/rule_logger.c
@@ -1466,6 +1466,7 @@ void ib_rule_log_phase(
/**
* Log a rule's transformations
*
+ * @param[in] mp Memory pool.
* @param[in] rule_exec Rule execution object
* @param[in] tgt Rule target logging object
* @param[in] rslt Matching result field (or NULL)
View
4 include/ironbee/engine_state.h
@@ -96,8 +96,8 @@ extern "C" {
*
* - Connection event hook callbacks receive a @ref ib_conn_t parameter.
* - Transaction event hook callbacks receive a @ref ib_tx_t parameter.
- * - Transaction Data event hook callbacks receive a @ref const char* and
- * size_t parameter.
+ * - Transaction Data event hook callbacks receive a `const char*` and
+ * `size_t` parameter.
*
* @note Config contexts and some fields are populated during the server
* events and thus the following handler event is what should be used
View
2  include/ironbee/state_notify.h
@@ -194,7 +194,7 @@ ib_status_t DLL_PUBLIC ib_state_notify_response_header_finished(ib_engine_t *ib,
*
* @param ib Engine handle
* @param tx Transaction
- * @param txdata Transaction data
+ * @param data Transaction data
* @param data_length Length of @a data
*
* @returns Status code
View
4 include/ironbeepp/apidoc.hpp
@@ -17,7 +17,7 @@
/**
* @file
- * @brief IronBee++ --- Top level doxygen page.
+ * @brief IronBee++ -- Top level doxygen page.
*
* This file contains only doxygen directives; no code is present.
*
@@ -25,7 +25,7 @@
*/
/**
- * \page ironbeepp IronBee++ --- A C++ API for IronBee
+ * \page ironbeepp IronBee++ -- A C++ API for IronBee
*
* IronBee++ is a (currently partial) C++ API for IronBee. It largely mimics
* the C API, but with many adaptations to C++ including:
View
2  modules/ident_authbasic.c
@@ -255,12 +255,14 @@ static ib_status_t ident_authbasic_init(ib_engine_t *ib, ib_module_t *m, void *c
};
return ib_ident_provider_register("authbasic", &ident_authbasic_provider);
}
+
/**
* Configuration function to set basic authentication realm
*
* @param cp IronBee configuration parser
* @param name Unused
* @param p1 Realm value to set
+ * @param dummy Ignored.
* @return OK
*/
static ib_status_t ident_authbasic_realm(ib_cfgparser_t *cp, const char *name,
View
2  modules/rules.c
@@ -1586,7 +1586,7 @@ ib_status_t parse_ruletrace_params(
*
* @param[in] cp Configuration parser.
* @param[in] name Name of directive.
- * @param[in] rule_id Parameter; ID of rule to trace.
+ * @param[in] path Path to write traces to.
* @param[in] cbdata Callback data; Unused.
* @returns IB_OK on success; IB_E* on error.
**/
View
3  predicate/eval.cpp
@@ -280,6 +280,8 @@ ValueList GraphEvalState::eval(const node_p& node, EvalContext context)
return node_eval_state.values();
}
+// Doxygen confused by this code.
+#ifndef DOXYGEN_SKIP
namespace Impl {
make_indexer_helper_t::make_indexer_helper_t(size_t& index_limit) :
@@ -310,6 +312,7 @@ void make_initializer_helper_t::operator()(const node_p& node)
}
}
+#endif
boost::function_output_iterator<Impl::make_indexer_helper_t>
make_indexer(size_t& index_limit)
View
2  predicate/eval.hpp
@@ -364,7 +364,7 @@ class GraphEvalState
/**
* True if node has no values.
*
- * @param[in] Index of node to check emptyness of.
+ * @param[in] index Index of node to check emptyness of.
* @return true iff node has singular or empty value list.
**/
bool empty(size_t index) const;
View
2  predicate/standard_valuelist.cpp
@@ -227,7 +227,7 @@ class cat_impl_t
node_list_t::const_iterator m_last_unfinished;
/**
- * Last value added from @ref last_unfinished.
+ * Last value added from @ref m_last_unfinished.
*
* A singular value means no children of @ref m_last_unfinished have
* been added.
Please sign in to comment.
Something went wrong with that request. Please try again.