Document Builder

# Document Builder

Check docs in UnityEditor at:

tools / NaiveAPI / Documentation / DocumentBuilder

github page

# Feature

- System.Type based API Editor/View

- Powerful Document Build up

- Friendly GUI in Editor

- Visual is allow in Runtime

- Customizable content

- Easy to Extends

- UIElement Extension

# What's New in 2.0?

The previous DocumentBuilder was designed exclusively for the Editor. However, in version 2.0, everything has been transformed into VisualElement, resulting in improved readability, expandability, and adaptability. Additionally, you can now utilize your docs at Runtime as well. However, please note that version 2.0 is not compatible with the older 1.x version. If you have a specific requirement for the older version, you can download it from the GitHub page.

In version 2.0, you have the flexibility to add your own DocType, and the system will automatically detect it. This allows you to customize all the contents you want to display. For example, you can implement an item system in your project or create a clock display with your desired specifications. The new version empowers you to tailor the documentation to your specific needs and requirements, enhancing the overall user experience.

Animation is a significant improvement in DocumentBuilder. Once you define the animation behavior, you can easily call it using a simple API interface. The built-in components also come with default Intro and Outtro animations, making it easy to add dynamic and engaging visual effects to your documents.

Release Notes

## [2.2.1] -2024-02-03

Fixed.

- EditorNamespace using in TypeField

- EditorNamespace using in SOScriptAPIInfo

- DSToggle not apply style

- Add object to TypeReader name table

## [2.2.0] -2024-01-28

### **IMPORTANT**

This version has reconstructed the way the ScriptingAPI is edited. As a result, the details and invocation of functions related to this API may be affected. Please be mindful of any update requirements.

Also, a part of the folder structure has been changed. It is recommended to delete it first and then reimport it.

Affected API:

- `DocumentBuilderParser.CalXXXTypeName()` move into `TypeReader` as

- TypeReader.GetName()

- TypeReader.GetSignature()

- TypeReader.GetNestedName()

- TypeReader.GetGenericName()

- TypeReader.GetAccessLevel()

- TypeReader.GetPrefix()

- `DocRuntime.FindAllTypesWhere()`

- TypeReader.FindAllTypesWhere()

- Animation Feture on

- DocVisual

- DocEditVisual

- DocPage

- DocPageVisual

- DocBookVisual

### Delete.

In the upcoming plan, adjustments will be made to the style, animations, and other aspects of the VisualElement. Therefore, the below content will be temporarily removed.

- Default DocStyle except DarkTheme

- Animation part on DocType

### Add.

- ScriptAPI Edit and View

- ScriptAPI Editor

- ScriptAPI Window

- DocComponentProperty, allow you to interaction with DocComponent or SerializedProperty in same API call.

- TypeReader, handle feture about System.Type

- ScriptAPIElement, display info base on MemberInfo/System.Type

### Refactored.

- DSTypeField, better search method and view

### Fixed.

- DocFuncDisplay error on wrong format.

- DocEditMatrix error on zero col/row.

### Obsolete.

- DocFuncDisplay

## [2.1.0] -2023-11-05

### This version change some API about DocStyle VisualElement.

### You need to add a Attribute to your CustomDocEditVisual after this version.

Refactored. DocRuntime

Refactored. DocEditorWindow

Refactored. DocRuntime.NewSomething() -> Group of DocVisualElement class

Improve. DocStyle layout

Add. Component version

Add. DocVisual Attribute

Add. DocPageFactory (old DocTemplate)

Add. DocumentEditor quick tutorial

## [2.0.1] -2023-09-01

Improve. DocStyle layout

Fixed. Parser Number/Typename bug

Add. Simple UIElement Extension Docs

Add. UIElement Extension asmdef

## [2.0.0] -2023-08-10

New Version of Document Builder release

old format are no longer supported. If needed, please download from github page

## [1.2.0] -2023-02-26

Refactored. better UI for edit docs

Add. hotkey for edit docs

## [1.1.1] -2023-02-23

Fixed. missing bookroot while first open

## [1.1.0] - 2023-02-21

Fixed. error from different numberFormat

Fixed. missing doc template folder

Fixed. CS0518 cause from invaiid named .asmdef

Add. export docs as markdown with a summary

Add. allow user add MenuItem to open docs window by other book root

## [1.0.0] - 2022-07-11

This is the first release of Document Builder as a built in package.