Will the new documentor be available for our own apps?

[dwahli]

Looking for the jsduck replacment and found this topic, but not sure what's the current situation.

We evaluate a migration from extjs 4.2 to 6.5 but we need a tool to extract the sources definition as JSON (as jsduck does).
Didn't try jsduck on extjs 6.5 sources yet, but it seems it's not the way to go as jsduck was replaced by something else.

In your last post you mention a new doc processor, is it the doxi command from the Sencha Cmd CLI 6.5 or is it something else ?
Can I use the current doxi command now and switch later to your new tool ? (the JSON outputs will be the same or very close ?)

Dominique

[greg.barry]

You can can certainly use Doxi as it's part of Cmd.

It will comb through your source code and output JSON. It's half of the tool that we use. The other half is the JSON processor. Check out this thread for instructions on using Doxi.

https://www.sencha.com/forum/showthread.php?311491

Thanks!
Greg

[valio]

Didn't try jsduck on extjs 6.5 sources yet, but it seems it's not the way to go as jsduck was replaced by something else.

You can still use JSDuck, if you don't need a docset for both toolkits and you're not using certain ES6 features (like template strings).

[ui.community]

You can can certainly use Doxi as it's part of Cmd.

It will comb through your source code and output JSON. It's half of the tool that we use. The other half is the JSON processor. Check out this thread for instructions on using Doxi.

https://www.sencha.com/forum/showthread.php?311491

Thanks!
Greg

Hi Greg. I hope you can post a simple Ext project with a project.doxi.json as bolierplate.

[greg.barry]

Hello!

In that other forum post I linked, you'll find full instructions and an example project.doxi.json file. Let me know if there's anything you're missing or if you need any further instructions. Here's a link directly to the post I'm talking about:

https://www.sencha.com/forum/showthread.php?311491

Thanks!
Greg

[valio]

Our first pass at our documentation software was rushed, and we created it with node, which we didn't have a lot of experience with. It was slow, unstable, and very very tied to our personal CI needs. We realized it wasn't going to be helpful for our users without some major modifications. (we as in the documentation team, not all of Sencha)

A couple months ago, we moved forward with our efforts to rebuild the doc processor with other users in mind. In this rebuild, we implemented multi-threading, smarter processing, fewer dependencies, a cleaner architecture so that users could modify and override as needed, etc. We are very happy with the results.

We are currently QA'ing the output for ExtReact and Ext JS 6.5. Once we're happy with the results, we'll rebuild all of our documentation with the new tool. At that point, we'll likely be ready to share the tool.

We really just want to be confident in the software before we release it.

Thanks!
Greg

Is there a roadmap for the release of this doc tool from Sencha?
I'd like to know whether there is a roadmap so that I can go for an alternative (e.g. JSDuck) if there is no roadmap from Sencha or if there is, but it won't match our project schedule.
I would love to use the new tool, but without the html renderer framework, doxi is almost useless to me.

[greg.barry]

Is there a roadmap for the release of this doc tool from Sencha?
I'd like to know whether there is a roadmap so that I can go for an alternative (e.g. JSDuck) if there is no roadmap from Sencha or if there is, but it won't match our project schedule.
I would love to use the new tool, but without the html renderer framework, doxi is almost useless to me.

Valio,

I don't want to disappoint you, but I don't think the documentation tool will make it to the public forum anytime soon.

If your project schedule is dependent on a documentation tool, I'd advise you to utilize JSDuck or something similar.

Thanks!
Greg

[bogc]

Where is this at?

Thanks

[greg.barry]

The team that created this tool has been gone from Sencha for over a year now. I can't speak for Sencha, but my guess would be that this particular project will not be made public since there is no-one left that had a hand in creating/using it. I'd recommend using Doxi to produce the JSON and then process that yourself, or look into other documentation tools that scan the source code and produce a web output. There are many options out there.

Thanks!
Greg

[geopalam]

For anyone here who is using es6 features and still waiting for sencha to release a documentation tool you can still get your documentation working with jsduck

Follow these steps (you need to have npm installed)

1. run "npm init"
2. open package.json and add this to it:

"devDependencies": {
    "babel-cli": "^6.26.0",
    "babel-core": "^6.26.3"
  }

and

"scripts": {
    "build": "babel src -d build"
  }

3. run "npm install"
4. run "touch .babelrc" and then edit that file and put in

{ 
  "presets": ["env"]
}

5. copy your es6 code base into your npm project under the src directory
6. run "npm run build"
7. the es5 version of your code should now be in the build directory, you can use jsduck on this directory to output your documentation

For more options checkout: https://babeljs.io/