Package com.iohao.net.framework.core.doc

package com.iohao.net.framework.core.doc

Provides documentation metadata and code-generation support used to produce client-facing API artifacts from ionet action definitions.

See Code Generation for examples targeting Unity, Godot, CocosCreator, Laya, Vue, and other clients.

Author:

渔民小镇

date:

2024-08-05

Related Packages

Package	Description
com.iohao.net.framework.core	Provides the core action execution model, metadata, lifecycle hooks, and shared runtime building blocks used by ionet business logic.

Class	Description
ActionCommandDoc	Action command document, stores source code information.
ActionCommandDocKit	Utility for scanning Java source files and building a map of JavaClassDocInfo from the Javadoc comments found in @ActionController classes.
ActionDoc	Documentation model for a single @ActionController, grouping all ActionCommandDoc entries that share the same primary command ID.
ActionDocument	Aggregated documentation model for a single ActionDoc, containing the generated member-constant documents and method-level documents used for client SDK code generation.
ActionMemberCmdDocument	Document model for a route member constant generated from an action method, carrying the command pair, a generated member name, and the Javadoc comment.
ActionMethodDocument	Documentation model for a single action method, capturing parameter types, return types, comments, and type-mapping information used for client SDK code generation.
BroadcastDocument	Documentation model for a single broadcast (server-push) route, describing the command info, data type, method name, and associated metadata used for client SDK code generation.
BroadcastDocumentBuilder	Builder for constructing BroadcastDocument instances that describe server-push routes, their data types, and method metadata.
Document	Document-related information, such as action-related, broadcast-related, and error code-related details.
DocumentAccessAuthentication	Document access permission generation
DocumentAnalyseKit	Utility for analysing action documents, error code enums, and Java source files to produce structured documentation models.
DocumentGenerate	Interface for connecting to the document generation service, allowing for different implementations to be extended.
DocumentHelper	Central helper for collecting action documentation, broadcast documents, error codes, and triggering document generation.
DocumentMethod	Generates the document action method name.
ErrorCodeDocument	Documentation model for a single error code entry, carrying the enum constant name, numeric value, and human-readable description.
JavaClassDocInfo	Wrapper around a QDox JavaClass that indexes its methods by signature and provides factory methods for creating ActionCommandDoc from reflection Method objects.
TextDocumentGenerate	DocumentGenerate implementation that produces a plain-text documentation file containing action routes, broadcast routes, and error codes.
TypeMappingDocument	Strategy interface for mapping Java/protobuf types to their client-side type names used during document and SDK code generation.
TypeMappingRecord	Record describing how a Java/protobuf type maps to client-side type names, SDK method names, and result accessor names used during code generation.