search

HaxeFoundation / dox

Haxe documentation generator.
MIT License
145 stars 36 forks source link

Feature request: Link to external API docs #251

Closed jgranick closed 4 years ago

jgranick commented 5 years ago

The OpenFL documentation links to types from Lime and Haxe.

It would be ideal if we could flag package paths to link to external Dox generated documentation sources, so https://api.openfl.org/openfl/utils/Future.html can link to https://api.lime.software/lime/app/Future.html or core types (such as String) can link to the Haxe docs (such as https://api.haxe.org/String.html)

Gama11 commented 5 years ago

I'm still maintaining a dox fork for Flixel just to make "View Source" link work across multiple repos / libs, which seems somewhat related to this.

Gama11 commented 4 years ago

As of 1.4.0, it's possible to use dox as a library and override Api.getSourceLink() to do whatever you need to. Usage example in flixel-docs here:

https://github.com/HaxeFlixel/flixel-docs/blob/c2b874a9e88d1997723f8a38bdc92c2242b50ece/api/dox/Main.hx