Hi, I’m rather new to xmms2 and programming. I’m trying to learn programming by writing an xmms2 client in ruby. It’s supposed to replace my MPD-setup.
While trying to find a way how to properly handle songinformation, which comes as a RawDict, I was pointed to the method to_propdict which is not explained/mentioned in the docs for the ruby bindings[1]. As having complete docs would help me a lot, I want to help documenting the available bindings. Taking a look at their code[2], I realised that I don’t know any C. Nor do I know how to properly use the system used for generating the documentation (it’s rdoc, right?). Thus a few questions arised: 1. How is documentation exactly generated? When I know the software and commands used I can do local testing if my changes produce the right outcome before asking for them to be included. 2. AFAICT the comment right before a methods definition is used for documenting that method, e.g. the comment in line 331 of rb_collection.c on [2] causes the [] method of the class Xmms::Collection::Attributes to be documented with HAVE_RB_PROTECT_INSPECT. Where there is no comment, the method will get an entry in the docs at all. Is that correct so far? 3. Looking at rb_collection.c on [2] again: It seems like almost no function in the bottom half of the file is commented at all and thus, if I’m correct on the point above, will never show in the docs. Is that intended? If any of you think I should go read certain docs, guides, faqs, … before asking any more stupid questions please tell me and I will take a look. Sorry if any of what I asked is obvious or well documented somewhere. Thanks in advance Kind regards henk PS: Should anyone want to take a look at my client, it’s called grux and has very basic functionality. Since I’m just starting real programming, I’d be thankful for any advice you have to offer regarding its developement! The code (as well as my changes to the docs as soon as I do any) can be found on [3] and be cloned from git://netwichtig.de/ too. [1] http://doxygen.xmms2.xmms.se/clientlib/stable/xmmsclient-ruby/ [2] http://git.xmms2.org/xmms2/xmms2-devel/tree/src/clients/lib/ruby [3] https://git.netwichtig.de/gitweb/
signature.asc
Description: PGP signature
-- _______________________________________________ Xmms2-devel mailing list [email protected] http://lists.xmms.se/cgi-bin/mailman/listinfo/xmms2-devel
