diff options
Diffstat (limited to 'src/third_party/wiredtiger/src/docs/Doxyfile')
| -rw-r--r-- | src/third_party/wiredtiger/src/docs/Doxyfile | 24 |
1 files changed, 14 insertions, 10 deletions
diff --git a/src/third_party/wiredtiger/src/docs/Doxyfile b/src/third_party/wiredtiger/src/docs/Doxyfile index e95d8babe48..178655bf6ed 100644 --- a/src/third_party/wiredtiger/src/docs/Doxyfile +++ b/src/third_party/wiredtiger/src/docs/Doxyfile @@ -205,12 +205,15 @@ TAB_SIZE = 8 # will result in a user-defined paragraph with heading "Side Effects:". # You can put \n's in the value part of an alias to insert newlines. -ALIASES = "notyet{1}=Note: <b>"\1"</b> not yet supported in WiredTiger.\n@todo fix when \1 supported\n\n" \ +ALIASES = \ + "config{3}= @row{<tt>\1</tt>,\2,\3}" \ + "configempty{2}=@param config\n Configuration string, see @ref config_strings. No values currently permitted." \ + "configend= </table>" \ + "configstart{2}=@param config\n Configuration string, see @ref config_strings. Permitted values:\n <table>@hrow{Name,Effect,Values}" \ +"ebusy_errors=@returns zero on success, EBUSY if the object is not available for exclusive access, and a non-zero error code on failure. See @ref error_handling \"Error handling\" for details." \ "errors=@returns zero on success and a non-zero error code on failure. See @ref error_handling \"Error handling\" for details." \ - "ebusy_errors=@returns zero on success, EBUSY if the object is not available for exclusive access, and a non-zero error code on failure. See @ref error_handling \"Error handling\" for details." \ + "exclusive=This method requires exclusive access to the specified data source(s). If any cursors are open with the specified name(s) or a data source is otherwise in use, the call will fail and return \c EBUSY.\n\n" \ "ex_ref{1}=@ref \1 \"\1\"" \ - "ref_single=@ref" \ - "subpage_single=@subpage" \ "hrow{1}=<tr><th>\1</th></tr>" \ "hrow{2}=<tr><th>\1</th><th>\2</th></tr>" \ "hrow{3}=<tr><th>\1</th><th>\2</th><th>\3</th></tr>" \ @@ -220,6 +223,12 @@ ALIASES = "notyet{1}=Note: <b>"\1"</b> not yet supported in Wired "hrow{7}=<tr><th>\1</th><th>\2</th><th>\3</th><th>\4</th><th>\5</th><th>\6</th><th>\7</th></tr>" \ "hrow{8}=<tr><th>\1</th><th>\2</th><th>\3</th><th>\4</th><th>\5</th><th>\6</th><th>\7</th><th>\8</th></tr>" \ "hrow{9}=<tr><th>\1</th><th>\2</th><th>\3</th><th>\4</th><th>\5</th><th>\6</th><th>\7</th><th>\8</th><th>\9</th></tr>" \ + "notyet{1}=Note: <b>"\1"</b> not yet supported in WiredTiger.\n@todo fix when \1 supported\n\n" \ + "plantuml_end=PlantUML template end -->" \ + "plantuml_start{1}=\image html \1\n\image latex \1\n<!-- PlantUML template begins" \ + "requires_notransaction=This method must not be called on a session with an active transaction.\n\n" \ + "requires_transaction=This method must be called on a session with an active transaction.\n\n" \ + "ref_single=@ref" \ "row{1}=<tr><td>\1</td></tr>" \ "row{2}=<tr><td>\1</td><td>\2</td></tr>" \ "row{3}=<tr><td>\1</td><td>\2</td><td>\3</td></tr>" \ @@ -229,12 +238,7 @@ ALIASES = "notyet{1}=Note: <b>"\1"</b> not yet supported in Wired "row{7}=<tr><td>\1</td><td>\2</td><td>\3</td><td>\4</td><td>\5</td><td>\6</td><td>\7</td></tr>" \ "row{8}=<tr><td>\1</td><td>\2</td><td>\3</td><td>\4</td><td>\5</td><td>\6</td><td>\7</td><td>\8</td></tr>" \ "row{9}=<tr><td>\1</td><td>\2</td><td>\3</td><td>\4</td><td>\5</td><td>\6</td><td>\7</td><td>\8</td><td>\9</td></tr>" \ - "configstart{2}=@param config\n Configuration string, see @ref config_strings. Permitted values:\n <table>@hrow{Name,Effect,Values}" \ - "config{3}= @row{<tt>\1</tt>,\2,\3}" \ - "configend= </table>" \ - "configempty{2}=@param config\n Configuration string, see @ref config_strings. No values currently permitted." \ - "plantuml_start{1}=\image html \1\n\image latex \1\n<!-- PlantUML template begins" \ - "plantuml_end=PlantUML template end -->" + "subpage_single=@subpage" \ # This tag can be used to specify a number of word-keyword mappings (TCL only). # A mapping has the form "name=value". For example adding |