https://github.com/elitemastereric/haxedoxinjector

A library which provides a macro to inject documentation into Haxe classes from JSON data.
https://github.com/elitemastereric/haxedoxinjector

documentation haxe macro

Last synced: 9 days ago
JSON representation

A library which provides a macro to inject documentation into Haxe classes from JSON data.

• Host: GitHub
• URL: https://github.com/elitemastereric/haxedoxinjector
• Owner: EliteMasterEric
• Created: 2023-11-24T06:59:43.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2023-11-24T08:14:37.000Z (about 1 year ago)
• Last Synced: 2024-12-02T11:44:47.119Z (2 months ago)
• Topics: documentation, haxe, macro
• Language: Haxe
• Homepage:
• Size: 10.6 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Haxe Dox Injector

A library which provides a macro to inject documentation into Haxe classes from JSON data.

## Installation

Install via Haxelib:

```

# Release

# Development

haxelib git haxe-dox-injector 

```

## Usage

Apply the macro. For example, this build script will inject documentation into `test.MyClassTwo` from `docs/test/MyClassTwo.json`.

```

# build.hxml

--library haxe-dox-injector

# Apply to a single class...

--macro addMetadata('@:build(dox.inject.Inject.apply("docs/"))', 'test.MyClassTwo')

# ...or to a whole package.

--macro addGlobalMetadata('test', '@:build(dox.inject.Inject.apply("docs/"))', true, true, true)

```

```json

// docs/test/MyClassTwo.json

{

  "classDoc": "This applies documentation on the class `MyClassTwo`",

  "fieldDocs": [

    {

      "name": "myField",

      "doc": "This applies documentation on the field `MyClassTwo#myField`"

    }

  ]

}

```

## License

Haxe Dox Injector is made available under the MIT License.