GithubHelp home page GithubHelp logo

API Documentation about haxelib HOT 3 OPEN

jasononeil avatar jasononeil commented on July 30, 2024
API Documentation

from haxelib.

Comments (3)

Simn avatar Simn commented on July 30, 2024

In theory Dox could support a run-time mode because hxtemplo works on all targets. I didn't properly look into it because the merged std API documentation XML comes in at more than 5 MB, making it a bit awkward to work with. It could be a nice feature for smaller documentation so I could work on that if you want to have it.

from haxelib.

jasononeil avatar jasononeil commented on July 30, 2024

If you think it would be fast enough then I think it could save some hassle
if we ever do template upgrades etc. But some libraries might have XML
files as big as the standard library. I know all the ufront docs when put
together weigh in at about 1MB per platform. I imagine OpenFL or Flixel
would be even bigger.

Do you think it's worth pursuing or is it easier to just output them all to
disk? That's what I'm leaning towards, but maybe there's some amazingly
fast implementation in Dox and HxTemplo that would change my mind...

On Sat, Feb 28, 2015 at 10:07 PM, Simon Krajewski [email protected]
wrote:

In theory Dox could support a run-time mode because hxtemplo works on all
targets. I didn't properly look into it because the merged std API
documentation XML comes in at more than 5 MB, making it a bit awkward to
work with. It could be a nice feature for smaller documentation so I could
work on that if you want to have it.


Reply to this email directly or view it on GitHub
#14 (comment).

from haxelib.

Simn avatar Simn commented on July 30, 2024

Ah, I thought this was just about providing downloadable versions of the API documentation. For displaying the pages directly it's gonna be impractical to load the XML files each time, even if you employ some caching.

from haxelib.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.