Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate docs #20

Open
Vindaar opened this issue Oct 20, 2018 · 1 comment
Open

Generate docs #20

Vindaar opened this issue Oct 20, 2018 · 1 comment

Comments

@Vindaar
Copy link
Owner

Vindaar commented Oct 20, 2018

Generate docs for the module.

@Vindaar
Copy link
Owner Author

Vindaar commented Feb 6, 2022

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... :(

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant