Where communities thrive


  • Join over 1.5M+ people
  • Join over 100K+ communities
  • Free without limits
  • Create your own community
People
Repo info
Activity
Pete Bacon Darwin
@petebacondarwin
It was for me to keep track of weirdnesses when migrating from the old old ngdocs for Angular to dgeni
along with the one in dgeni itself: https://github.com/angular/dgeni/blob/master/README.md
The ngdoc package was originally only going to be used by the Angular.js project itself so I didn't spend much time making it generic or configurable
Peeter Tomberg
@peeter-tomberg
I meant the actual jsdoc tags, e.g. $packageFile that's referenced module.template.html
Or are all jsdoc tags available ?
Pete Bacon Darwin
@petebacondarwin
But other packages can and do add their own also
Pete Bacon Darwin
@petebacondarwin
OK, so remember that while tags are one way to put a property onto a document, processors can also attach properties too
Go to go. Feel free to hit me with more questions and feedback and I will pick them up later
Peeter Tomberg
@peeter-tomberg
Thanks, Ive got enough to get the ball rolling at the moment,.
Peeter Tomberg
@peeter-tomberg
After 5hs of working on it, I got it to work
The examples block is extremly powerful
What I did not understand was the deployment part.
I understand that some of the parts are required for the examples iframe, but the general concept is still a mystery to me
Peeter Tomberg
@peeter-tomberg
@petebacondarwin Do factories go under "services" ?

Or am I missing something when I do:

/**

  • @ngdoc factory
  • @name UrlParamUpdaterFactory
  • @description A wrapper for $location. Updates the $location.search key
    */
Peeter Tomberg
@peeter-tomberg
Seems like factory and controller are missing from ngdoc? Should I use object?
Lola Dam
@rllola
@petebacondarwin Quick question : I have been following john papa style guide (https://github.com/johnpapa/angular-styleguide). This means that I have everything seperated in several file (.module.js, .controller.js, .service.js, ...) So when I set the readFilesProcessor.sourceFiles to `{ include: 'client/app/**/.js'}. I have an error saying that my module haven't been fond. But when I load the js script separatly starting with*.module.js` files he does work properly. Why does it react like that ? Does there is a simpler way to do it ?
Pete Bacon Darwin
@petebacondarwin
@peeter-tomberg it is a common misconception that factory and service define different kinds of things. But really they are just different ways of registering services. So just use @service
@rllola perhaps it needs the module file to be loaded first?
Lola Dam
@rllola
@petebacondarwin That's what I've been thinking. Another thing, does there is some more templates and documentation/tutorial on dgeni ?
Forresst
@forresst
@petebacondarwin
By testing Espree, I added a file named test.es6.
I have the following error:
error: Error: No file reader found for c: /lab/dgeni-espree/src/test.es6"
This is normal, as is defaultPattern Reader jsdoc .js
A small question, what is the best way to add
.es6?
Pete Bacon Darwin
@petebacondarwin
@forresst You could update the file reader (it contains a default file pattern to match against filenames) or you can specify which file reader to use explicitly in your source info.
Forresst
@forresst
The second case is awesome ! thanks
Note : In the next commit for Espree, it may be necessary to add .es6 to the package jsdoc :
defaultPattern: /\.js|\.es6$/,
Srini
@bsraju1979
Hi team, Please let me know the process how to execute protractor tests in IE browser?
Dave Gavigan
@dgavigan
Howdy. I am looking to get a super simple example of dgeni with ng-doc instead of jsdoc. Iv’e followed the paper trail as best I can so im not asking the same questions everyone else is asking, and managed to fork and generate some docs from the sample app. However, I am still having issues with “Dangling Links”. If anyone could check it out and offer where I might be going wrong, I would greatly appreciate it! dg1202/dgeni-angular#1
lgiglio
@lgsoftwareqa
Hi There folks, I'm interested in using Protractor for e2e testing a non AngularJS web. Feasible ? Or too much overhead ? Otherwise was thinking of just using mocha and its libraries etc...
Claudio Romano
@claudiocro

@petebacondarwin
/*
@ngdoc controller
@name SomeController
@description Controlls something
/

Seems that controller is missing, should i use object?

Pete Bacon Darwin
@petebacondarwin
The ngdoc package was designed for the angular.js core project, where we have no controllers. You should be able to configure your use of it to handle controller docs.
Saurabh06
@Saurabh06
How to set global variable from protractor conf onPrepare() to use in spec file
Pete Bacon Darwin
@petebacondarwin
? @Saurabh06 can you give some more context?
Saurabh06
@Saurabh06
@petebacondarwin thanks for response, issue is resolved..
Pete Bacon Darwin
@petebacondarwin
thanks - sorry for the delay. Gitter is not my communication channel of choice
Backig
@Backig
Hi, sorry for my question... I'm new with Dgeni... I'm trying to convert my .md files in html with Dgeni but I have this error: No file reader found for /Users/macbookair11/project/README.md... Do you know what I have to do?
Francis Nepomuceno
@n3ps
Hi, new to dgeni. Does anyone know how to add css to the partials that get generated?
Tom McKearney
@tommck
anyone have luck using dgeni with webpack2? I migrated a project to using webpack from gulp and realized that there doesn't seem to be much support for dgeni in webpack
Rodolfo Aguirre
@roddolf
Hello, does anyone know a workarround for methods overloading in Typescript?? I only get the first signature in the members array.
burka
@burka
Hi! I am trying to setup dgeni for a existing angular project, I looked at the example-project and some blog post and finally got it generating at least some documentation. But trying to generate just a simple index-page seems to be another huddle of tasks to be done, I tried starting with the angular index page processor from https://github.com/angular/angular.js/blob/master/docs/config/processors/index-page.js removed the deployments dependency and am now looking for the template.. It seems like every ordinary thing to be done for generating a simple documentation requires a new effort.
Is there a ready-made module that can just generate angular documentation with dgeni with some reasonable defaults that are tweakable?
It's an ordinary angularJS (1.6.x) + Webpack2 with es6-modules project.
burka
@burka
If anyone has any idea that might help, I asked about the index-app on stackoverflow: https://stackoverflow.com/q/45218243/510711
Pete Bacon Darwin
@petebacondarwin
@roddolf - we support overloads in the typescript dgeni package now. There is an overloads property on each class/interface doc.
Kritsadakorn
@KritsadakornKa2_twitter
Hi