Inconsistent Documentation about node-mumble

[Prior99]

Yes it is not up-to-date.

[Rantanen]

@Prior99, when you did the documentation, did you have a look at JSDoc or anything similar? Think it might be better to have the documentation derived from the code in the long run. Of course for stuff like events we'd then need to add more syntax in the code..

[Rantanen]

How would https://github.com/Rantanen/node-mumble/wiki/APIv2 look?

That's done using the jsdoc comments in the cec9e2d commit and jsdoc2md.

Didn't try documenting the events yet though so those are missing - and only tested on that one class.

[Prior99]

I like it. No I didn't have a look at it, I wantes to have it done fast ;-) who likes to write documentation?

[Rantanen]

Working on this (because it's easier than the input streams which are a lot of work :p): e0d7d49

Travis is under maintenance so wasn't able to push this there. Ideally in future it would be enough to land the documentation as JSDoc among the code and Travis build would push the documentation online to the wiki. Would let us document the functionality as we implement it instead of having to go to the wiki later to update it.

[Prior99]

I like it.

[johnrnelson]

Allow me to say the documentation is not as good as the code. However, I'm loving that code so where does that leave us? :-)

[Rantanen]

The documentation is now generated from the JSDoc comments so it should be less outdated.

https://github.com/Rantanen/node-mumble/wiki/MumbleWrapper
https://github.com/Rantanen/node-mumble/wiki/User
https://github.com/Rantanen/node-mumble/wiki/Channel

Can't say whether the actual quality went up or down, but it should at least be easier to maintain while implementing new features now.

[Prior99]

Wow. I love it. Thank you so much, writing doc is pain in the ass.

[timeDev]

Well then. Even though the new documentation is awesome, I still can't track users moving :(
Closed.

[bendem]

Maybe the example here can help you? Though I agree it's not documented in User

[timeDev]

I already tried that, the event didn't seem to get fired...

2015-05-14 12:41 GMT+02:00 bendem [email protected]:

Maybe the example here
https://github.com/Rantanen/node-mumble/wiki/MumbleWrapper#event-user-
can help you? Though I agree it's not documented in User
https://github.com/Rantanen/node-mumble/wiki/User

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

[bendem]

Just tried

connection.on('user-move', function(user, fromChannel, toChannel) {
    console.log('User ' + user.name + ' moved from channel ' + fromChannel.name + ' to ' + toChannel.name);
});

and it displayed User bendem moved from channel A to B as expected.

[timeDev]

Ok then maybe I had a typo or something...
I will definately try this!

2015-05-14 12:50 GMT+02:00 bendem [email protected]:

Just tried

connection.on('user-move', function(user, fromChannel, toChannel) {
console.log('User ' + user.name + ' moved from channel ' + fromChannel.name + ' to ' + toChannel.name);
});

and it displayed User bendem moved from channel A to B as expected.

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