Fix some doxygen format problems and trim trailing whitespace.

git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@223912 65c4cc65-6c06-0410-ace0-fbb531ad65f3

include/asterisk/pbx.h

@@ -50,9 +50,10 @@ extern "C" {
 
 #define PRIORITY_HINT	-1	/*!< Special Priority for a hint */
 
-/*! \brief Extension states 
+/*!
-	\note States can be combined 
+ * \brief Extension states
-	- \ref AstExtState
+ * \note States can be combined
+ * \ref AstExtState
  */
 enum ast_extension_states {
 	AST_EXTENSION_REMOVED = -2,	/*!< Extension removed */
@@ -129,20 +130,23 @@ struct ast_timing {
 	char *timezone;                 /*!< NULL, or zoneinfo style timezone */
 };
 
-/*!\brief Construct a timing bitmap, for use in time-based conditionals.
+/*!
+ * \brief Construct a timing bitmap, for use in time-based conditionals.
  * \param i Pointer to an ast_timing structure.
  * \param info Standard string containing a timerange, weekday range, monthday range, and month range, as well as an optional timezone.
  * \retval Returns 1 on success or 0 on failure.
  */
 int ast_build_timing(struct ast_timing *i, const char *info);
 
-/*!\brief Evaluate a pre-constructed bitmap as to whether the current time falls within the range specified.
+/*!
+ * \brief Evaluate a pre-constructed bitmap as to whether the current time falls within the range specified.
  * \param i Pointer to an ast_timing structure.
  * \retval Returns 1, if the time matches or 0, if the current time falls outside of the specified range.
  */
 int ast_check_timing(const struct ast_timing *i);
 
-/*!\brief Deallocates memory structures associated with a timing bitmap.
+/*!
+ * \brief Deallocates memory structures associated with a timing bitmap.
  * \param i Pointer to an ast_timing structure.
  * \retval 0 success
  * \retval non-zero failure (number suitable to pass to \see strerror)
@@ -264,8 +268,10 @@ void ast_context_destroy(struct ast_context *con, const char *registrar);
  */
 struct ast_context *ast_context_find(const char *name);
 
-/*! \brief The result codes when starting the PBX on a channel with \see ast_pbx_start.
+/*!
-	AST_PBX_CALL_LIMIT refers to the maxcalls call limit in asterisk.conf
+ * \brief The result codes when starting the PBX on a channel with ast_pbx_start.
+ * \note AST_PBX_CALL_LIMIT refers to the maxcalls call limit in asterisk.conf
+ * \see ast_pbx_start
  */
 enum ast_pbx_result {
 	AST_PBX_SUCCESS = 0,
@@ -860,12 +866,14 @@ int ast_context_lockmacro(const char *macrocontext);
  */
 int ast_context_unlockmacro(const char *macrocontext);
 
-/*!\brief Set the channel to next execute the specified dialplan location.
+/*!
+ * \brief Set the channel to next execute the specified dialplan location.
  * \see ast_async_parseable_goto, ast_async_goto_if_exists
  */
 int ast_async_goto(struct ast_channel *chan, const char *context, const char *exten, int priority);
 
-/*!\brief Set the channel to next execute the specified dialplan location.
+/*!
+ * \brief Set the channel to next execute the specified dialplan location.
  */
 int ast_async_goto_by_name(const char *chan, const char *context, const char *exten, int priority);
 
@@ -934,14 +942,17 @@ struct ast_ignorepat *ast_walk_context_ignorepats(struct ast_context *con,
 struct ast_sw *ast_walk_context_switches(struct ast_context *con, struct ast_sw *sw);
 /*! @} */
 
-/*!\brief Create a human-readable string, specifying all variables and their corresponding values.
+/*!
+ * \brief Create a human-readable string, specifying all variables and their corresponding values.
  * \param chan Channel from which to read variables
- * \param buf Dynamic string in which to place the result (should be allocated with \see ast_str_create).
+ * \param buf Dynamic string in which to place the result (should be allocated with ast_str_create).
+ * \see ast_str_create
  * \note Will lock the channel.
  */
 int pbx_builtin_serialize_variables(struct ast_channel *chan, struct ast_str **buf);
 
-/*!\brief Return a pointer to the value of the corresponding channel variable.
+/*!
+ * \brief Return a pointer to the value of the corresponding channel variable.
  * \note Will lock the channel.
  *
  * \note This function will return a pointer to the buffer inside the channel
@@ -960,29 +971,34 @@ int pbx_builtin_serialize_variables(struct ast_channel *chan, struct ast_str **b
  */
 const char *pbx_builtin_getvar_helper(struct ast_channel *chan, const char *name);
 
-/*!\brief Add a variable to the channel variable stack, without removing any previously set value.
+/*!
+ * \brief Add a variable to the channel variable stack, without removing any previously set value.
  * \note Will lock the channel.
  */
 void pbx_builtin_pushvar_helper(struct ast_channel *chan, const char *name, const char *value);
 
-/*!\brief Add a variable to the channel variable stack, removing the most recently set value for the same name.
+/*!
+ * \brief Add a variable to the channel variable stack, removing the most recently set value for the same name.
  * \note Will lock the channel.  May also be used to set a channel dialplan function to a particular value.
  * \see ast_func_write
  */
 void pbx_builtin_setvar_helper(struct ast_channel *chan, const char *name, const char *value);
 
-/*!\brief Retrieve the value of a builtin variable or variable from the channel variable stack.
+/*!
+ * \brief Retrieve the value of a builtin variable or variable from the channel variable stack.
  * \note Will lock the channel.
  */
 void pbx_retrieve_variable(struct ast_channel *c, const char *var, char **ret, char *workspace, int workspacelen, struct varshead *headp);
 void pbx_builtin_clear_globals(void);
 
-/*!\brief Parse and set a single channel variable, where the name and value are separated with an '=' character.
+/*!
+ * \brief Parse and set a single channel variable, where the name and value are separated with an '=' character.
  * \note Will lock the channel.
  */
 int pbx_builtin_setvar(struct ast_channel *chan, const char *data);
 
-/*!\brief Parse and set multiple channel variables, where the pairs are separated by the ',' character, and name and value are separated with an '=' character.
+/*!
+ * \brief Parse and set multiple channel variables, where the pairs are separated by the ',' character, and name and value are separated with an '=' character.
  * \note Will lock the channel.
  */
 int pbx_builtin_setvar_multiple(struct ast_channel *chan, const char *data);
@@ -1151,12 +1167,13 @@ int ast_func_read2(struct ast_channel *chan, const char *function, struct ast_st
 int ast_func_write(struct ast_channel *chan, const char *function, const char *value);
 
 /*!
+ * \details
  * When looking up extensions, we can have different requests
  * identified by the 'action' argument, as follows.
- * Note that the coding is such that the low 4 bits are the
+ *
+ * \note that the coding is such that the low 4 bits are the
  * third argument to extension_match_core.
  */
-
 enum ext_match_t {
 	E_MATCHMORE = 	0x00,	/* extension can match but only with more 'digits' */
 	E_CANMATCH =	0x01,	/* extension can match with or without more 'digits' */