[bind10-dev] doxygen samples

[Shane Kerr]

Jinmei,

On Thu, 2009-10-22 at 17:14 -0700, JINMEI Tatuya / 神明達哉 wrote:
> Snapshot examples of HTML output generated by doxygen are
> (tentatively) available here:
> http://www.jinmei.org/bind10/api/index.html
> (many of the pages under the top page are just indices and boring,
> except these two:
> http://www.jinmei.org/bind10/api/class_i_s_c_1_1_d_n_s_1_1_name.html
> http://www.jinmei.org/bind10/api/class_i_s_c_1_1_d_n_s_1_1_name_comparison_result.html)

It looks quite okay. I have a lot of nits and questions, but it seems
usable.

As for nits and questions, in no particular order... :)

      * Is it possible to generate a "all classes on one page" listing?
        I often find myself clicking around endlessly on documentation
        that separates things by classes or method (for example the
        default Javadoc output). Not surprisingly, I like the Python
        docs: http://docs.python.org/library/zipfile.html
      * Man those URLs are u_g_l_y_1_1_1
      * Presumably when NameCompressor is also doxygenated then it will
        have nice links to it in the method descriptions that use that
        type?
      * The HTML seems to require Javascript. Not a huge deal, but it
        seems strange as a requirement.

Even without these it's certainly good enough, I think.

--
Shane