libnds documentation incomplete?

[vuurrobin]

hello everybody

I've been looking in the libnds documentation for some time, and I noticed that there are some things that aren't in there.

now it could be that they aren't included because they are very small and that is seems unnecesairy to put it in, but I think that it's very usefull to include it so people know they can use it without looking in the code.

the things I couldn't find in the documentation are POWER_ALL_2D, which is an PM_Bits enum in system.h, lcdMainOnTop()/Bottom(), which are inline functions in system.h, and BIT(), which is an define in ndstypes.h.

I'm sure there are more things that aren't documented.

doxigen has a option to include things in the documentation that aren't documented in a doxigen way. maybe its usefull to use that?

and put a link of it on the main page. currently there isn't one and if you dont know where to look, you wont find the documentation.

[dovoto]

hello everybody

I've been looking in the libnds documentation for some time, and I noticed that there are some things that aren't in there.

now it could be that they aren't included because they are very small and that is seems unnecesairy to put it in, but I think that it's very usefull to include it so people know they can use it without looking in the code.

the things I couldn't find in the documentation are POWER_ALL_2D, which is an PM_Bits enum in system.h, lcdMainOnTop()/Bottom(), which are inline functions in system.h, and BIT(), which is an define in ndstypes.h.

I'm sure there are more things that aren't documented.

doxigen has a option to include things in the documentation that aren't documented in a doxigen way. maybe its usefull to use that?

and put a link of it on the main page. currently there isn't one and if you dont know where to look, you wont find the documentation.

Yes documentation is still a bit behind implementation, a link on the front page is a good call. I prefer not to have the docs pic up things unless we explicitly tell it to. Mainly because there are a few things in the headers that are meant for internal use only and having them in the docs might be confusing.

The examples you mentioned however are definitely meant to be public and I will take a poke about and see if I can clean it up some.

[ShotgunNinja]

Hello, I just wanted to bump this up to try to get some updates on the documentation and its current state of incompletion.

I'm starting a group for video game development at the Milwaukee School of Engineering, and I was hoping to use devkitPro to allow the other members to program a game for the Nintendo DS. As I was writing a facade class to wrap access to the PersonalData pointer, I realized that there is no documentation for the languages for the bitfield for DS language:

Code: Select all

// Declared in <system.h> as:
typedef struct tPERSONAL_DATA {
// ...
   packed_struct {
      unsigned language : 3;  //!< User's language.
      // ...
   } _user_data;
   // ...
} PACKED PERSONAL_DATA;

// Accessed by:
(PersonalData->_user_data).language;

Now, I understand that this may be considered a minor problem, but I would like to offer a more complete interface for the higher-level programmers to play with; and besides, there are much more serious things which are not well-documented, and although this is probably the least of the issues, I would still like to know what those values correspond with. Thank you.

[StevenH]

Check the GBATek pages for any information relating to these types of issues (missing information about the bitfields etc)

http://nocash.emubase.de/gbatek.htm

[ShotgunNinja]

Hey, @StevenH, thanks for the tip with the GBATek page... It's helped me out a lot.

P.S. Is there any way you guys could package an offline-mode HTML version of the libnds Documentation? I work a lot during the summer without internet access, and it would be very helpful to get a working offline-mode version of the docs, so I can pound out code without having to go to the library (grrr...)

[Discostew]

Hey, @StevenH, thanks for the tip with the GBATek page... It's helped me out a lot.

P.S. Is there any way you guys could package an offline-mode HTML version of the libnds Documentation? I work a lot during the summer without internet access, and it would be very helpful to get a working offline-mode version of the docs, so I can pound out code without having to go to the library (grrr...)

I'm pretty sure you can just save the HTM file onto your computer, as there are no outside references within it that require internet access.

EDIT:

Scratch that. I was thinking GBATek offline document, not libnds offline document.

[vuurrobin]

you can still do it with the libnds documentation, if you are willing to save every htm file. which may be alot of work.

you can also download the source code from svn, install doxygen, and type 'make docs' in the libnds source code folder. that should give you the documentation.



it seems that there is still some errors and stuff missing in the documentation. maybe I'll write the documentation and add it as a patch to the svn in the summer.

[WinterMute]

There's a documentation tarball in the latest libnds release at https://sourceforge.net/projects/devkit ... es/libnds/

Patches to the doxygen documentation are very welcome