Add comments

git-svn-id: http://svn.code.sf.net/p/netpbm/code/trunk@1455 9d0c8265-081b-0410-96cb-a4ca84ce46f8

1 files changed, 6 insertions, 0 deletions

diff --git a/converter/bmp.h b/converter/bmp.h
index 80e93fba..6a883394 100644
--- a/converter/bmp.h
+++ b/converter/bmp.h
@@ -145,7 +145,13 @@ static __inline__ unsigned int
 BMPlencolormap(enum bmpClass const class,
                unsigned int  const bitcount, 
                unsigned int  const cmapsize) {
+/*----------------------------------------------------------------------------
+   The number of bytes of the BMP stream occupied by the colormap in a
+   BMP of class 'class' with 'bitcount' bits per pixel and 'cmapsize'
+   entries in the palette.
 
+   'cmapsize' == 0 means there is no palette.
+-----------------------------------------------------------------------------*/
     unsigned int lenrgb;
     unsigned int lencolormap;