4 ms·
The Android SDK is well documented with examples throughout and hyperlinked to examples and posts which explain some content in greater depth.
by redwoolf 4y ago
The Android SDK is well documented with examples throughout and hyperlinked to examples and posts which explain some content in greater depth.
- Aaargh20318 4y agoDid they improve it recently ? I haven’t developed for Android in a while but it used to be terrible. Full of absolutely useless method descriptions. For example, I remember getting frustrated because of the docs for a setTextSize method, with the helpful description “sets the text size”. Nice. Very helpful that it didn’t mention what unit the parameter was, especially since (after experimentation) it turns out the unit is not the one you would expect for a font size. The API docs were full of that kind of ‘documentation’, setX: “Sets X”. If you are writing documentation, please explain what method parameters and return values actually mean, what the units used are. Especially if uses a unit no one expects. For example: font sizes are usually specified in points, if you expect them to be specified in pixels you should absolutely mention that.
- drpixie 4y agoReally? Most of it seems to be machine generated from the code definitions - very little explanation, very little usage info. I find it terrible.
- IshKebab 4y agoYeah that's been my experience too. Tons of "flobinate(bool yes): If yes is set to true, enables flobination. Otherwise it disables it. Returns void.". Completely unhelpful. I think this is particularly a problem with Java docs because Java IDEs auto-insert useless documentation and people think "oh great it's documented".