documentation

Amazon Kindle eBooks: OPF file example

As a quick note today, I’ve been trying to build my own Amazon Kindle eBook using HTML and CSS, and yesterday I learned that I also need an OPF file as part of the process of creating both the eBook and the Table of Contents (TOC).

This morning I found that Amazon has a collection of sample books that you can use with Kindlegen, and the “Guide” project specifically includes the following example OPF file, which is well-documented.

My Android AsyncTask docs and examples (parameters, callbacks, executing, canceling)

I’ve currently written this document as a “note to self” about how the Android AsyncTask works. It’s currently incomplete, but if you want to know how an AsyncTask works, most of the answers are generally here. I provide documentation for most aspects of the AsyncTask, though my coverage of (a) updating progress/status and (b) canceling an AsyncTask is a little weak atm.

Scala/SBT: How to generate project API documentation

This is an excerpt from the Scala Cookbook (partially modified for the internet). This is Recipe 18.8, “Generating SBT Project API Documentation.”

Problem

In an SBT project, you’ve marked up your Scala source code with Scaladoc comments, and want to generate the API documentation for your project.

Solution

Use any of the SBT commands listed in the following table, depending on your documentation needs.

The karma of bad software documentation

Tried to use someone’s software library.
Documentation was bad, couldn’t get it to work.
Used someone else’s.

#haiku-ish

How to generate Scala documentation with the ‘scaladoc’ command alvin June 20, 2015 - 4:27pm

This is an excerpt from the Scala Cookbook (partially modified for the internet). This is Recipe 14.8, “How to generate Scala documentation with the scaladoc command.”

Problem

You’ve annotated your Scala code with Scaladoc, and you want to generate developer documentation for your API.

Best Sencha Touch 2 docs and examples

I’ve said it before, so I’ll only say it again briefly: I don’t like the Sencha Touch 2 documentation, I think it could be much more organized, deeper, and with better examples. So, in short, here are some links to the best Sencha Touch 2 documentation I can find.

Sencha Touch Guides (lists UI components):

Play Framework Recipes

Here’s the cover for my new, free PDF, Play Framework Recipes. (I obviously didn’t put much work into the cover, lol.) As the title implies, the book is a collection of cookbook-style recipes for the Play Framework. The book is about 80 pages in length, is currently available as a PDF, and will soon be available as a Kindle eBook. Here’s a link to more information on Play Framework Recipes.