公開するドキュメントの査読

アプリのマニュアルはちゃんとチェックしているのにそれ以外のドキュメントがさっぱりらしい。外部に公開されている開発者向けのドキュメントを、必要になったのでちょっと読んでいたら色々怪しい箇所が。関数リファレンスなんですが、引数リストにある引数とその解説がちぐはぐだったり穴があったり。使い方が解りません……。

関数の作りも微妙に怪しいかも。引数に配列とそのサイズを渡すような似たような関数がふたつあるのですが、片方はサイズとして配列の要素数を求めていて、片方は配列全体のバイト数を求めている。これはちょっと、使いにくいんでは。まあもう世に出てしまっているし、いまさらな話ですけれども。

しかしドキュメントの方は直さないとまずいから、とりあえず最初から読んで、修正箇所まとめて直してもらおう。ただその前に、自分の仕事を片付けなければならないので、ソース追いかけて不明な点補完しないと……。