DocumentAnalyseKit (ionet 25.5 API)

java.lang.Object

com.iohao.net.framework.core.doc.DocumentAnalyseKit

public class DocumentAnalyseKit extends Object

Utility for analysing action documents, error code enums, and Java source files to produce structured documentation models.

Author:: 渔民小镇
date:: 2024-06-26

Constructor Summary

Constructors

Constructor

Description

DocumentAnalyseKit()
Method Summary

Modifier and Type

Method

Description

List<ActionDocument>

analyseActionDocument(Document document, TypeMappingDocument typeMappingDocument)

Analyse all action documents and produce a list of ActionDocument models.

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- DocumentAnalyseKit
  
  public DocumentAnalyseKit()
Method Details
- analyseActionDocument
  
  public List<ActionDocument> analyseActionDocument(Document document, TypeMappingDocument typeMappingDocument)
  
  Analyse all action documents and produce a list of ActionDocument models.
  
  Parameters:
  
  document - the raw document containing action doc list
  
  typeMappingDocument - the type mapping configuration
  
  Returns:
  
  list of analysed action documents (only those with methods)