Comments (18)
hi @ihadeed
me too was looking for dgeni tutorials,
found these,
https://forum.ionicframework.com/t/how-to-generate-our-code-documentation-with-dgeni/20056
https://github.com/rangle/angular2-dgeni-starter
may be useful for you
from awesome-cordova-plugins.
Is the comment style you're using a standard, or are you doing your own thing?
from awesome-cordova-plugins.
Not sure what you mean @mlynch
from awesome-cordova-plugins.
@ihadeed basically, is the whole Platforms?: iOS, Android, Windows
a standard syntax that a doc tool understands, or would we need to build a doc parser (in dgeni, for example) to handle that?
from awesome-cordova-plugins.
@mlynch I did some modifications in the dgeni template to display the platforms
parameter for methods only. The comments displayed in the image are for an interface.. they are not being parsed or displayed in docs, just there for reference.
from awesome-cordova-plugins.
Cool, I'm trying to figure out how we might get those comments that document the actual object into a doc so people can see the params...
from awesome-cordova-plugins.
I had no luck finding any dgeni tutorials/docs...
from awesome-cordova-plugins.
@mlynch do you guys already have code for this in the ionic framework repo? or should I write it from scratch?
from awesome-cordova-plugins.
Just had a look at https://github.com/driftyco/ionic-native/blob/master/scripts/docs/typescript-package/processors/readTypeScriptModules.spec.js#L69-L132
Seems like the processor can already read interfaces. It just needs to be rendered in the template.
from awesome-cordova-plugins.
@ihadeed Adjust template https://github.com/driftyco/ionic-native/blob/master/scripts/docs/templates/common.template.html maybe need processor
from awesome-cordova-plugins.
@ramonornela seems like the typescript-package
folder contains processors that can parse interfaces, but I don't see them being imported anywhere in the process of doc generation.
I will look into it more tonight and see how this could be done.
from awesome-cordova-plugins.
Ionic Native usage
"dgeni": "^0.4.2",
"dgeni-packages": "^0.10.18"
Typescript Package available in 0.12.
from awesome-cordova-plugins.
Problem too Ionic see LoadingController LoadingOptions.
from awesome-cordova-plugins.
I think that dgeni Ionic can be created a project separated and use npm as well ionic-app-scripts
from awesome-cordova-plugins.
@ramonornela seems like the typescript-package folder contains processors that can parse interfaces, but I don't see them being imported anywhere in the process of doc generation.
In dgeni-config register processor
from awesome-cordova-plugins.
@ramonornela yeah I saw that page in the framework's docs. They're typing the docs manually for the interfaces. But the interfaces are written in a different file, maybe that's why.
In our case it should be easier to automatically document them since everything is one page.
from awesome-cordova-plugins.
I think that @see resolve
@see {@link /docs/native/<link> <Name Link>}
from awesome-cordova-plugins.
Yeah you're right they're registered in dgeni-config .. https://github.com/driftyco/ionic-native/blob/master/scripts/docs/dgeni-config.js#L4
I just looked into the code and figured out how (almost) everything works. Looks like dgeni opens up index.ts
as a module and parses it's exports. It doesn't care if there are multiple classes/interfaces in a file, they still get separate files generated.
I think this current method wouldn't work out for ionic-native
since we have lots of classes that are linked together and it wouldn't make sense to have separate pages. For example, the Google Maps plugin has many classes and interfaces exported, ideally we need all of them to be documented in the same page.
I suggest changing the doc generation process for ionic native and make it loop through all the .ts
files and treating each file as a module instead. Alternatively, we could "import" the docs we need semi-manually. That can work by creating a function (macro) that fetches the doc we need by name (it can get it from doc.moduleDoc.exports[<NAME HERE>]
). The second option is probably easier to achieve.
from awesome-cordova-plugins.
Related Issues (20)
- Where to find real documentations? HOT 1
- Plugin bluetooth-le>RespondParams Interface> Missing optional property: address HOT 1
- download PDF file from external website with inappbrowser HOT 1
- Avoid `any` type and use tsdoc comment properly. HOT 1
- [BLE] Missing method `requestConnectionPriority`. HOT 1
- Creating Cordova Plugin HOT 1
- Add interface to diagnostic plugin HOT 1
- @awesome-cordova-plugins/local-notifications: getAllScheduled and getAllTriggered not working in Cordova HOT 1
- Is there any Unity3D plugin? HOT 1
- Plugin for Google Nearby Connections HOT 1
- social-sharing :: not working on onePlus device when share mp4 video. HOT 1
- Exception calling Diagnostic.requestBluetoothAuthorization method HOT 1
- Cannot find plugin.xml
- requestConnectionPriority() is missing in BLE plugin HOT 1
- @awesome-cordova-plugins/media seems not to work at all HOT 1
- @ionic-native/in-app-purchase-2 isnt compatible with billingclient v5 as required by Google to update apps HOT 1
- Where is @ionic-native/sqlite in awesome-cordova-plugins? HOT 1
- Can you add cordova-plugin-autostart please
- in-app-browser: actually support browser platform
- in-app-browser: error WEBPACK_IMPORTED_MODULE_2__.InAppBrowser.create is not a function HOT 5
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from awesome-cordova-plugins.