Fix Doxygen API documentation markup

psifertex · psifertex · commit f16809f1fa44 · 2026-07-22T09:58:27.000-04:00
diff --git a/binaryninjaapi.h b/binaryninjaapi.h
diff --git a/enterprise.h b/enterprise.h
@@ -241,8 +241,8 @@ namespace BinaryNinja
 		public:
 			/*!
 			    RAII constructor that checks out a license. License will be refreshed
-			    automatically in a background thread while checked out, in intervals of `duration`
-			    In the event of program crash, the license will expire `duration` seconds after
+			    automatically in a background thread while checked out, in intervals of \c duration
+			    In the event of program crash, the license will expire \c duration seconds after
 			    the most recent background refresh, so you may want a smaller value like 60 if
 			    you expect your program to crash / be killed often.
 			    See class docs for example usage.
diff --git a/ffi.h b/ffi.h
@@ -77,7 +77,7 @@ namespace BinaryNinja
 			};
 
 		If you get weird compiler errors around here, make sure you've implemented
-		the above interface correctly (with the `const`s too!).
+		the above interface correctly (with the \c consts too!).
 	 */
 	template<
 		typename T,
@@ -158,7 +158,7 @@ namespace BinaryNinja
 		\tparam F Throwable block
 		\tparam C Catch handler
 		\param func Throwable block to execute
-		\param catcher Catch handler to execute if `func` throws
+		\param catcher Catch handler to execute if \c func throws
 		\return Either the func's result or the handler's result
 	 */
 	template<typename T, typename F, typename C>
diff --git a/objectivec/objc.h b/objectivec/objc.h
@@ -153,7 +153,7 @@ namespace BinaryNinja {
 	public:
 		virtual ~ObjCReader() = default;
 
-		/*! Read from the current cursor position into buffer `dest` and advance the cursor that many bytes
+		/*! Read from the current cursor position into buffer \c dest and advance the cursor that many bytes
 
 		    \throws Exception
 			\param dest Address to write the read bytes to
diff --git a/plugins/efi_resolver/include/Resolver.h b/plugins/efi_resolver/include/Resolver.h
@@ -53,8 +53,8 @@ class Resolver
 	static string nonConflictingLocalName(Ref<Function> func, const string& basename);
 
 	/*!
-	Define the structure used at the callsite with type `typeName`, propagate it to the data section. If it's a
-	structure type, define it fields according to the `followFields` parameter. The input `addr` should be a call
+	Define the structure used at the callsite with type \c typeName, propagate it to the data section. If it's a
+	structure type, define it fields according to the \c followFields parameter. The input \c addr should be a call
 	instruction \param func the function that contains the callsite (it's parent function) \param addr address of the
 	callsite \param typeName the type that need to define \param paramIdx the parameter index that want to define \param
 	followFields whether to define the structure's fields if they are pointers \return False if failed
diff --git a/ui/animation.h b/ui/animation.h
@@ -88,9 +88,9 @@ class BINARYNINJAUIAPI Animation : public QVariantAnimation
 	static Animation* createCopy(Animation* animation);
 	/*! Whether reduced motion is enabled for the BinaryNinja Application.
 
-	    This will return true if the `binaryninja.ui.motion` setting is enabled.
+	    This will return true if the \c binaryninja.ui.motion setting is enabled.
 
-	    The `binaryninja.ui.motion` setting will be enabled automatically if the Operating System's reduce motion
+	    The \c binaryninja.ui.motion setting will be enabled automatically if the Operating System's reduce motion
 	    setting is turned on.
 
 	    \return Whether reduced motion is enabled.
diff --git a/ui/backgroundsortfilterrows.h b/ui/backgroundsortfilterrows.h
@@ -20,7 +20,7 @@
 #include "base/assertions.h"
 #include "binaryninjacore.h"
 
-/*! The non-template portion of `BackgroundSortFilterRows`.
+/*! The non-template portion of \c BackgroundSortFilterRows.
 	Contains the background job state machine, watcher lifecycle, and abandonment protocol,
 	which are independent of the row type.
 
diff --git a/ui/createarraydialog.h b/ui/createarraydialog.h
@@ -39,7 +39,7 @@ class CreateArrayDialog : public QDialog
 
 	/// Get the desired array element type from the accepted dialog.
 	///
-	/// The returned value will NOT be of `Type::ArrayType(...)`, but rather
+	/// The returned value will NOT be of \c Type::ArrayType(...), but rather
 	/// the element inside.
 	[[nodiscard]] TypeRef elementType() const;
 
diff --git a/ui/globalarea.h b/ui/globalarea.h
@@ -14,7 +14,7 @@
 
 /*!
     \ingroup globalarea
-    \deprecated Use `SidebarWidget` with `SidebarContextSensitivity::Global` instead
+    \deprecated Use \c SidebarWidget with \c SidebarContextSensitivity::Global instead
 */
 class BINARYNINJAUIAPI GlobalAreaWidget : public SidebarWidget
 {
diff --git a/ui/linearview.h b/ui/linearview.h
@@ -414,7 +414,7 @@ private Q_SLOTS:
 
 	//! Get the length of of the string (if there is one) starting at the
 	//! given address. String type is assumed to be UTF-8 by default, but the
-	//! `charSize` parameter can be set to 2 or 4 to look for UTF-16 or
+	//! \c charSize parameter can be set to 2 or 4 to look for UTF-16 or
 	//! UTF-32 string, respectively.
 	//!
 	//! Returns the length of the string in bytes, NOT the number of characters.
diff --git a/ui/progresstask.h b/ui/progresstask.h
@@ -201,8 +201,8 @@ std::function<QVariant(QVariant)> convertToQVariantFunction(Func&& func);
 
     \b Example:
     \code{.cpp}
-        // Passing `this` into create() will make the thread stop if `this` is deleted before it finishes.
-        // Though note that `this` could still be deleted during a background action,
+        // Passing \c this into create() will make the thread stop if \c this is deleted before it finishes.
+        // Though note that \c this could still be deleted during a background action,
         // and the thread will only be stopped *after* the action is done, so you must be
         // sure to always guard data accessed in background actions with something like
         // a std::shared_ptr<T>.
@@ -502,7 +502,7 @@ class BINARYNINJAUIAPI BackgroundThread : public QObject
 	}
 
 	/*!
-	    Add another BackgroundThread's functions to the end of this one's. Will move functions out of `other`
+	    Add another BackgroundThread's functions to the end of this one's. Will move functions out of \c other
 	    \param other BackgroundThread whose functions will be used
 	    \return This BackgroundThread
 	 */
diff --git a/ui/sidebarwidget.h b/ui/sidebarwidget.h
@@ -253,12 +253,12 @@ class BINARYNINJAUIAPI SidebarWidgetType
 	const QString& name() const { return m_name; }
 
 	/*!
-	    \deprecated Use `defaultLocation()`
+	    \deprecated Use \c defaultLocation()
 	*/
 	virtual bool isInReferenceArea() const { return false; }
 
 	/*!
-	    \deprecated Use `contextSensitivity()`
+	    \deprecated Use \c contextSensitivity()
 	*/
 	virtual bool viewSensitive() const { return true; }
 
@@ -267,7 +267,7 @@ class BINARYNINJAUIAPI SidebarWidgetType
 	virtual bool alwaysShowTabs() const { return false; }
 
 	/*!
-	    \deprecated Use `defaultIconVisibility()`
+	    \deprecated Use \c defaultIconVisibility()
 	*/
 	virtual bool hideIfNoContent() const { return false; }
 
diff --git a/ui/stackview.h b/ui/stackview.h
@@ -270,15 +270,15 @@ class BINARYNINJAUIAPI StackView : public QAbstractScrollArea, public View, publ
 	//! Show the "Create Variable" dialog.
 	void showCreateVariableDialog();
 
-	//! Create an integer of the given size at the cursor position. Pass `0`
-	//! for `size` to cycle through integer sizes automatically.
+	//! Create an integer of the given size at the cursor position. Pass \c 0
+	//! for \c size to cycle through integer sizes automatically.
 	void quickCreateIntegerAtCursor(size_t size);
 
 	//! Toggle the sign of the integer at the cursor position.
 	void quickInvertIntegerSignAtCursor();
 
-	//! Create an float of the given size at the cursor position. Pass `0`
-	//! for `size` to cycle through float sizes automatically.
+	//! Create an float of the given size at the cursor position. Pass \c 0
+	//! for \c size to cycle through float sizes automatically.
 	void quickCreateFloatAtCursor(size_t size);
 
 	//! Create a pointer the cursor.
diff --git a/ui/tokenizedtextview.h b/ui/tokenizedtextview.h
@@ -117,7 +117,7 @@ class BINARYNINJAUIAPI TokenizedTextView :
 
 	//! Get the length of of the string (if there is one) starting at the
 	//! given address. String type is assumed to be UTF-8 by default, but the
-	//! `charSize` parameter can be set to 2 or 4 to look for UTF-16 or
+	//! \c charSize parameter can be set to 2 or 4 to look for UTF-16 or
 	//! UTF-32 string, respectively.
 	//!
 	//! Returns the length of the string in bytes, NOT the number of characters.
diff --git a/ui/uicontext.h b/ui/uicontext.h
@@ -317,12 +317,12 @@ class BINARYNINJAUIAPI UIContextNotification
 
 	/*!
 	    Callback when an action is executed, allowing plugins to intercept and modify
-	    the behavior of the action. Plugins may modify the `action` parameter and
+	    the behavior of the action. Plugins may modify the \c action parameter and
 	    specify new behavior for the action to execute, which will happen immediately
 	    after all registered notifications have been notified.
 
 	    The original behavior (potentially modified by another notification) can be
-	    executed by saving a copy of the value of `action` and calling it from within
+	    executed by saving a copy of the value of \c action and calling it from within
 	    your modified value.
 
 	    \param context
diff --git a/view/sharedcache/ui/triagetable.h b/view/sharedcache/ui/triagetable.h
@@ -72,7 +72,7 @@ class ImageNameLookup
 
 
 /*! A row that resolves to an image and region, so it can be displayed and ranked in the Image
-	column. `imageStart` is 0 when the row is outside any image; `regionStart` is 0 when it is
+	column. \c imageStart is 0 when the row is outside any image; \c regionStart is 0 when it is
 	outside any region.
 */
 template <typename Row>
@@ -142,7 +142,7 @@ std::function<std::strong_ordering(const Row&, const Row&)> ImageColumnOrdering(
 
 
 /*! Shared portion of the triage view's flat table models: the filter state and the text matching
-	common to the tables. Row storage lives in the typed subclass `TriageTableRowsModel`.
+	common to the tables. Row storage lives in the typed subclass \c TriageTableRowsModel.
 */
 class TriageTableModel : public QAbstractTableModel
 {

Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@`
`14`	`14`
`15`	`15`	`/*!`
`16`	`16`	`\ingroup globalarea`
`17`		- \deprecated Use `SidebarWidget` with `SidebarContextSensitivity::Global` instead
	`17`	`+ \deprecated Use \c SidebarWidget with \c SidebarContextSensitivity::Global instead`
`18`	`18`	`*/`
`19`	`19`	`class BINARYNINJAUIAPI GlobalAreaWidget : public SidebarWidget`
`20`	`20`	`{`