More documentation improvements

.gitignore

@@ -1 +1,2 @@
 /docs
+/build

Doxyfile

@@ -54,7 +54,7 @@ PROJECT_NUMBER         =
 # for a project that appears at the top of each page and should give viewers a
 # quick idea about the purpose of the project. Keep the description short.
 
-PROJECT_BRIEF          = "An untainted clean room reverse engineered VST 2.x SDK"
+PROJECT_BRIEF          = "A recreation of the popular Steinberg VST 2.x SDK."
 
 # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
 # in the documentation. The maximum height of the logo should not exceed 55
@@ -74,7 +74,7 @@ PROJECT_ICON           =
 # entered, it will be relative to the location where Doxygen was started. If
 # left blank the current directory will be used.
 
-OUTPUT_DIRECTORY       = docs
+OUTPUT_DIRECTORY       = build/docs
 
 # If the CREATE_SUBDIRS tag is set to YES then Doxygen will create up to 4096
 # sub-directories (in 2 levels) under the output directory of each output format
@@ -215,7 +215,7 @@ SHORT_NAMES            = NO
 # explicit @brief command for a brief description.)
 # The default value is: NO.
 
-JAVADOC_AUTOBRIEF      = NO
+JAVADOC_AUTOBRIEF      = YES
 
 # If the JAVADOC_BANNER tag is set to YES then Doxygen will interpret a line
 # such as
@@ -653,7 +653,7 @@ INTERNAL_DOCS          = NO
 # Possible values are: SYSTEM, NO and YES.
 # The default value is: SYSTEM.
 
-CASE_SENSE_NAMES       = SYSTEM
+CASE_SENSE_NAMES       = YES
 
 # If the HIDE_SCOPE_NAMES tag is set to NO then Doxygen will show members with
 # their full class and namespace scopes in the documentation. If set to YES, the
@@ -1388,7 +1388,7 @@ GENERATE_HTML          = YES
 # The default directory is: html.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_OUTPUT            = .
+HTML_OUTPUT            = html
 
 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
 # generated HTML page (for example: .htm, .php, .asp).
@@ -1843,7 +1843,7 @@ ENUM_VALUES_PER_LINE   = 4
 # enumeration values besides the enumeration mnemonics.
 # The default value is: NO.
 
-SHOW_ENUM_VALUES       = NO
+SHOW_ENUM_VALUES       = YES
 
 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
 # to set the initial width (in pixels) of the frame in which the tree is shown.

vst.h

@@ -1556,7 +1556,7 @@ enum VST_EFFECT_OPCODE {
 
 	/** Enable/Disable bypassing the effect.
 	 *
-	 * See VST_EFFECT_OPCODE_SUPPORTS with vst_effect_supports.bypass for more information.
+	 * See @ref VST_EFFECT_OPCODE_SUPPORTS with @ref vst_effect_supports.bypass for more information.
 	 * 
 	 * @param p_int2 Zero if bypassing the effect is disabled, otherwise 1.
 	 */
@@ -1566,9 +1566,8 @@ enum VST_EFFECT_OPCODE {
 
 	/** Retrieve the effect name into the ptr buffer.
 	 *
-	 * Bug: Some officially licensed hosts do not provide the expected buffer size! The lowest I've seen is 32 bytes.
-	 * 
-	 * @param p_ptr `char[VST_BUFFER_SIZE_EFFECT_NAME]` Zero terminated string. 
+	 * @bug Various hosts only provide a buffer that is 32 bytes long.
+	 * @param p_ptr A zero terminated char buffer of size @ref VST_BUFFER_SIZE_EFFECT_NAME. 
 	 * @return Always 0, even on failure.
 	 */
 	VST_EFFECT_OPCODE_2D          = 0x2D,
@@ -1584,7 +1583,7 @@ enum VST_EFFECT_OPCODE {
 	 * Note: Not called in almost all licensed hosts.
 	 * Note: The buffer size varies wildly and there appears to be no common size.
 	 * 
-	 * @param p_ptr `char[...]` Zero terminated string buffer to which we write our error message.
+	 * @param p_ptr A zero terminated char buffer with undefined size.
 	 * @return VST_STATUS_TRUE if we could translate the error, VST_STATUS_FALSE if not.
 	 */
 	VST_EFFECT_OPCODE_2E              = 0x2E,