]> git.sur5r.net Git - i3/i3/commit
Put documentation for each function in the header files, doxygen-compatible
authorMichael Stapelberg <michael+x200@stapelberg.de>
Tue, 7 Apr 2009 17:02:07 +0000 (19:02 +0200)
committerMichael Stapelberg <michael+x200@stapelberg.de>
Tue, 7 Apr 2009 17:02:07 +0000 (19:02 +0200)
commitbd9de8189b987a05046e69bc30e75f1f4e80d81b
treef7c0602026013c58b34d7be7a7a672357e427e71
parentcb7b7a73d2900a0c846997e888e36ec9ffbd0782
Put documentation for each function in the header files, doxygen-compatible

Thanks to psychoschlumpf for the hint. Having comments in the headers
makes it easier to get the big picture when not being interested in the
source.

The doxygen file extracts as much as it can into HTML files. Please note
that this is not official/supported documentation, but rather being nice
to people who have to/want to use doxygen (I don’t).

Let me paste the header of the doxygen file:

  You can use this file with doxygen to create a pseudo-documentation
  automatically from source. doxygen-comments are not used very extensively
  in i3, mostly for the reason that it clutters the source code and has no
  real use (doxygen’s output looks really ugly).

  So, if you want to use it, here you go. This is however not a supported
  document, and I recommend you have a look at the docs/ folder or at
  http://i3.zekjur.net/ for more, real documentation.
include/commands.h
include/config.h
include/handlers.h
include/layout.h
include/table.h
include/util.h
include/xcb.h
include/xinerama.h
pseudo-doc.doxygen [new file with mode: 0644]
src/layout.c
src/table.c