Module qilletni.api
Record Class FunctionDoc
java.lang.Object
java.lang.Record
dev.qilletni.api.lang.docs.structure.text.inner.FunctionDoc
-
Constructor Summary
ConstructorsConstructorDescriptionFunctionDoc(@Nullable DocDescription description, List<ParamDoc> paramDocs, @Nullable ReturnDoc returnDoc, @Nullable DocOnLine docOnLine, @Nullable DocErrors docErrors) Creates an instance of aFunctionDocrecord class. -
Method Summary
Modifier and TypeMethodDescription@Nullable DocDescriptionReturns the value of thedescriptionrecord component.@Nullable DocErrorsReturns the value of thedocErrorsrecord component.@Nullable DocOnLineReturns the value of thedocOnLinerecord component.final booleanIndicates whether some other object is "equal to" this one.final inthashCode()Returns a hash code value for this object.Returns the value of theparamDocsrecord component.@Nullable ReturnDocReturns the value of thereturnDocrecord component.final StringtoString()Returns a string representation of this record class.
-
Constructor Details
-
FunctionDoc
public FunctionDoc(@Nullable @Nullable DocDescription description, List<ParamDoc> paramDocs, @Nullable @Nullable ReturnDoc returnDoc, @Nullable @Nullable DocOnLine docOnLine, @Nullable @Nullable DocErrors docErrors) Creates an instance of aFunctionDocrecord class.- Parameters:
description- the value for thedescriptionrecord componentparamDocs- the value for theparamDocsrecord componentreturnDoc- the value for thereturnDocrecord componentdocOnLine- the value for thedocOnLinerecord componentdocErrors- the value for thedocErrorsrecord component
-
-
Method Details
-
toString
-
hashCode
-
equals
Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared withObjects::equals(Object,Object). -
description
Returns the value of thedescriptionrecord component.- Returns:
- the value of the
descriptionrecord component
-
paramDocs
-
returnDoc
Returns the value of thereturnDocrecord component.- Returns:
- the value of the
returnDocrecord component
-
docOnLine
Returns the value of thedocOnLinerecord component.- Returns:
- the value of the
docOnLinerecord component
-
docErrors
Returns the value of thedocErrorsrecord component.- Returns:
- the value of the
docErrorsrecord component
-