GithubHelp home page GithubHelp logo

Comments (8)

mootari avatar mootari commented on July 3, 2024

It looks like both the parser that creates the AST as well as the docs pages are custom implementations. Was this done to reduce deployment complexity (dependencies, reliance on 3rd party tools), or because no viable alternatives existed at that time?

from olddocumentationsite.

deltakosh avatar deltakosh commented on July 3, 2024

We did not find good stuff 3years ago but if you know something worth looking please let me know

from olddocumentationsite.

mootari avatar mootari commented on July 3, 2024

http://typedoc.org/ might be worth a try. What are special features provided by the custom implementation that may not be available in a generic solution?

from olddocumentationsite.

mootari avatar mootari commented on July 3, 2024

I expect that switching to typedoc would be a lot more involved than just tackling the issue in the current builder, as described in my comment in #713.

The current builder relies on the typescript-services package for the AST which in turn has been marked as obsolete and had its last update in 2014. I suspect that switching to the new node API for the TypeScript parser should get rid of the ghost members/parameters, although the rendered markdown might need some fixing as well.

from olddocumentationsite.

deltakosh avatar deltakosh commented on July 3, 2024

Do you mind trying to move to the new API?

from olddocumentationsite.

mootari avatar mootari commented on July 3, 2024

Sooo ... typescript-services essentially uses a compiled TypeScript 1.0.0 (April 2014) where union types didn't even exist (at least the tests for those where added late 2014). In early 2015 TypeScript moved its compiler API around, and since then the compiler related APIs are no longer exposed to NodeJS.

There may be ways to patch typescript to reexpose them, but I'd argue that the time is better spent moving to TypeDoc and making it work for BabylonJS, especially given how much custom code in the builder currently relies on that dated API.

from olddocumentationsite.

deltakosh avatar deltakosh commented on July 3, 2024

whatever works :)

from olddocumentationsite.

deltakosh avatar deltakosh commented on July 3, 2024

Fixed with typedoc

from olddocumentationsite.

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.