Vindaar/nimhdf5

Generate docs

Vindaar opened this issue · 1 comments

Generate docs for the module.

I just gave generating the docs another try:

The issue is that nim doc chokes on the ## headers of many of the wrapped files. For example in hdf5_wrapper.nim the following header:

##  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
##  Copyright by The HDF Group.                                               *
##  Copyright by the Board of Trustees of the University of Illinois.         *
##  All rights reserved.                                                      *
##                                                                            *
##  This file is part of HDF5.  The full HDF5 copyright notice, including     *
##  terms governing use, modification, and redistribution, is contained in    *
##  the COPYING file, which can be found at the root of the source code       *
##  distribution tree, or in https://support.hdfgroup.org/ftp/HDF5/releases.  *
##  If you do not have access to either file, you may request a copy from     *
##  help@hdfgroup.org.                                                        *
##  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *

causes it to throw:

/home/basti/CastData/ExternCode/nimhdf5/src/nimhdf5/hdf5_wrapper.nim(9, 15) Error: new section expected (syntax error)

and from there it all goes downhill... :(