GP-0: Fixing some javadoc

This commit is contained in:
Ryan Kurtz 2025-03-14 06:57:57 -04:00
parent 825e8b811d
commit c964163c80
5 changed files with 9 additions and 10 deletions

View file

@ -94,8 +94,8 @@ public class GoRttiMapper extends DataTypeMapper implements DataTypeMapperContex
* automatically {@link #close() closed} when the current analysis session is finished. * automatically {@link #close() closed} when the current analysis session is finished.
* <p> * <p>
* NOTE: Only valid during an analysis session. If outside of an analysis session, use * NOTE: Only valid during an analysis session. If outside of an analysis session, use
* {@link #getGoBinary(Program)} to create a new instance if you need to use this outside * {@link #getGoBinary(Program, TaskMonitor)} to create a new instance if you need to use this
* of an analyzer. * outside of an analyzer.
* *
* @param program golang {@link Program} * @param program golang {@link Program}
* @param monitor {@link TaskMonitor} * @param monitor {@link TaskMonitor}

View file

@ -273,8 +273,7 @@ public class GoTypeManager {
} }
/** /**
* Finds a go type by its go-type name, from the list of * Finds a go type by its go-type name
* {@link #discoverGoTypes(TaskMonitor) discovered} go types.
* *
* @param typeName name string * @param typeName name string
* @return {@link GoType}, or null if not found * @return {@link GoType}, or null if not found
@ -622,7 +621,7 @@ public class GoTypeManager {
/** /**
* Returns category path that should be used to place recovered golang types. * Returns category path that should be used to place recovered golang types.
* @param packagePath optional package path of the type (eg. "utf/utf8", or "runtime") * @param symbolName the symbol from which to get the package path
* @return {@link CategoryPath} to use when creating recovered golang types * @return {@link CategoryPath} to use when creating recovered golang types
*/ */
public CategoryPath getCP(GoSymbolName symbolName) { public CategoryPath getCP(GoSymbolName symbolName) {

View file

@ -127,7 +127,6 @@ public class GoFuncType extends GoType {
* Returns a string that describes the function type as a golang-ish function decl. * Returns a string that describes the function type as a golang-ish function decl.
* *
* @param funcName optional name of a function * @param funcName optional name of a function
* @param receiverString optional receiver decl string
* @return golang func decl string * @return golang func decl string
*/ */
public String getFuncPrototypeString(String funcName) { public String getFuncPrototypeString(String funcName) {

View file

@ -193,7 +193,8 @@ public abstract class QuickFix {
/** /**
* QuickFix items can override this method if they want to do some special navigation when the * QuickFix items can override this method if they want to do some special navigation when the
* table selection changes or the user double clicks (or presses <return> key) to navigate. * table selection changes or the user double clicks (or presses {@code <return>} key) to
* navigate.
* @param services the tool service provider * @param services the tool service provider
* @param fromSelectionChange true if this call was caused by the table selection changing * @param fromSelectionChange true if this call was caused by the table selection changing
* @return true if this item handles the navigation and false if the QuickFix did not * @return true if this item handles the navigation and false if the QuickFix did not

View file

@ -34,14 +34,14 @@ import javax.swing.JComponent;
* To create a wizard dialog, the developer needs to create the following:<br> * To create a wizard dialog, the developer needs to create the following:<br>
* <OL> * <OL>
* <LI> A class that extends this WizardModel. </LI> * <LI> A class that extends this WizardModel. </LI>
* <LI> One or more classes that extend {@link WizardStep}<br> * <LI> One or more classes that extend {@link WizardStep}</LI>
* <LI> A data class that holds that data being collected by this wizard.<br> * <LI> A data class that holds that data being collected by this wizard.</LI>
* </OL> * </OL>
* *
* Subclasses must at a minimum implement two methods. * Subclasses must at a minimum implement two methods.
* <OL> * <OL>
* <LI> AddWizardSteps() - This is where the model defines the ordered list of * <LI> AddWizardSteps() - This is where the model defines the ordered list of
* {@link WizardStep} for this wizard. * {@link WizardStep} for this wizard.</LI>
* <LI> doFinish() - This is where the model should perform the main action of the wizard. This * <LI> doFinish() - This is where the model should perform the main action of the wizard. This
* will be called when the user presses the <B>Finish</B> button and all the panels have * will be called when the user presses the <B>Finish</B> button and all the panels have
* had a chance to update the wizard data object.</LI> * had a chance to update the wizard data object.</LI>