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

doxygen warnings #2329

Closed
edwardhartnett opened this issue May 3, 2022 · 4 comments
Closed

doxygen warnings #2329

edwardhartnett opened this issue May 3, 2022 · 4 comments

Comments

@edwardhartnett
Copy link
Contributor

There are doxygen warnings:

error: Tag file '../../NUG/html/nug.tag' does not exist or is not a file. Skipping it...
/home/ed/n3/docs/nczarr.md:203: warning: Unsupported xml/html tag <dataset> found
/home/ed/n3/docs/nczarr.md:495: warning: Unsupported xml/html tag <region> found
/home/ed/n3/docs/nczarr.md:495: warning: explicit link request to 'mode' could not be resolved
/home/ed/n3/docs/FAQ.md:71: warning: unable to resolve reference to 'ncdump_guide' for \ref command
/home/ed/n3/docs/FAQ.md:332: warning: unable to resolve reference to 'getting_and_building_netcdf' for \ref command
/home/ed/n3/docs/FAQ.md:502: warning: unable to resolve reference to 'getting_and_building_netcdf' for \ref command
/home/ed/n3/docs/tutorial.dox:53: warning: unable to resolve reference to 'ncdump_guide' for \ref command
/home/ed/n3/docs/tutorial.dox:61: warning: unable to resolve reference to 'guide_ncgen' for \ref command
/home/ed/n3/docs/tutorial.dox:62: warning: unable to resolve reference to 'guide_ncgen3' for \ref command
/home/ed/n3/docs/tutorial.dox:69: warning: unable to resolve reference to 'guide_nccopy' for \ref command
/home/ed/n3/docs/tutorial.dox:248: warning: unable to resolve reference to 'netcdf_format' for \ref command
/home/ed/n3/docs/tutorial.dox:801: warning: unable to resolve reference to 'build_parallel' for \ref command
/home/ed/n3/docs/tutorial.dox:440: warning: unable to resolve reference to 'building' for \ref command
/home/ed/n3/docs/tutorial.dox:53: warning: unable to resolve reference to 'ncdump_guide' for \ref command
/home/ed/n3/docs/tutorial.dox:61: warning: unable to resolve reference to 'guide_ncgen' for \ref command
/home/ed/n3/docs/tutorial.dox:62: warning: unable to resolve reference to 'guide_ncgen3' for \ref command
/home/ed/n3/docs/tutorial.dox:69: warning: unable to resolve reference to 'guide_nccopy' for \ref command
/home/ed/n3/docs/tutorial.dox:248: warning: unable to resolve reference to 'netcdf_format' for \ref command
/home/ed/n3/docs/tutorial.dox:440: warning: unable to resolve reference to 'building' for \ref command
/home/ed/n3/docs/tutorial.dox:801: warning: unable to resolve reference to 'build_parallel' for \ref command
/home/ed/n3/libdispatch/dvar.c:149: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/dvar.c:150: warning: unable to resolve reference to 'data_type' for \ref command
/home/ed/n3/libdispatch/dvar.c:639: warning: explicit link request to 'NC_EINVEL' could not be resolved
/home/ed/n3/libdispatch/dvar.c:490: warning: explicit link request to 'NC_QUANTIZE_' could not be resolved
/home/ed/n3/libdispatch/dvar.c:537: warning: explicit link request to 'NC_QUANTIZE_MAX_FLOAT_NSB' could not be resolved
/home/ed/n3/libdispatch/dvar.c:538: warning: explicit link request to 'NC_QUANTIZE_MAX_DOUBLE_NSB' could not be resolved
/home/ed/n3/libdispatch/dvarinq.c:77: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/dattget.c:85: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/dattget.c:473: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/dattget.c:440: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/dattget.c:374: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/dattget.c:407: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/dattget.c:605: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/dattget.c:208: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/dattget.c:341: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/dattget.c:730: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/dattget.c:175: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/dattget.c:506: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/dattget.c:350: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/dattget.c:370: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/dattget.c:318: warning: argument 'ncid' from the argument list of nc_get_att_uchar has multiple @param documentation sections
/home/ed/n3/libdispatch/dattget.c:318: warning: argument 'varid' from the argument list of nc_get_att_uchar has multiple @param documentation sections
/home/ed/n3/libdispatch/dattget.c:318: warning: argument 'name' from the argument list of nc_get_att_uchar has multiple @param documentation sections
/home/ed/n3/libdispatch/dattget.c:318: warning: argument 'value' from the argument list of nc_get_att_uchar has multiple @param documentation sections
/home/ed/n3/libdispatch/dattget.c:572: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/dattget.c:638: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/dattget.c:539: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/dattinq.c:30: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/dattinq.c:33: warning: unable to resolve reference to 'data_type' for \ref command
/home/ed/n3/libdispatch/dattinq.c:104: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/dattinq.c:375: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/dattinq.c:187: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/dattinq.c:318: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/dattinq.c:321: warning: unable to resolve reference to 'data_type' for \ref command
/home/ed/n3/libdispatch/dattput.c:170: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/dattput.c:443: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/dattput.c:409: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/dattput.c:341: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/dattput.c:375: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/dattput.c:579: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/dattput.c:239: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/dattput.c:307: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/dattput.c:60: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/dattput.c:104: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/dattput.c:477: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/dattput.c:273: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/dattput.c:545: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/dattput.c:614: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/dattput.c:511: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/datt.c:70: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/datt.c:71: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/dcompound.c:25: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/denum.c:26: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/dopaque.c:18: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/dvlen.c:93: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/dcompound.c:160: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/dcompound.c:265: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/dcompound.c:463: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/dcompound.c:311: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/dcompound.c:193: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/denum.c:88: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/denum.c:155: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/denum.c:127: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/dopaque.c:48: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/dtype.c:90: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/dtype.c:121: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/dvlen.c:128: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/dcompound.c:117: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/dcompound.c:80: warning: unable to resolve reference to 'object_name' for \ref command
/home/ed/n3/libdispatch/denum.c:56: warning: unable to resolve reference to 'object_name' for \ref command
make[2]: Leaving directory '/home/ed/n3/docs'
@edwardhartnett
Copy link
Contributor Author

OK, one big problem is that the object_name was in the NUG, which has now been removed. So I need to add that back in, and that will make most of the warnings disappear. The section is here: https://docs.unidata.ucar.edu/nug/current/netcdf_data_set_components.html#object_name

@edwardhartnett
Copy link
Contributor Author

OK, I've got a further PR that takes this down to:

cp auth.md obsolete/fan_utils.html html
/home/ed/n3/docs/nczarr.md:495: warning: Unsupported xml/html tag <region> found
/home/ed/n3/docs/nczarr.md:495: warning: explicit link request to 'mode' could not be resolved
/home/ed/n3/libdispatch/dattget.c:318: warning: argument 'ncid' from the argument list of nc_get_att_uchar has multiple @param documentation sections
/home/ed/n3/libdispatch/dattget.c:318: warning: argument 'varid' from the argument list of nc_get_att_uchar has multiple @param documentation sections
/home/ed/n3/libdispatch/dattget.c:318: warning: argument 'name' from the argument list of nc_get_att_uchar has multiple @param documentation sections
/home/ed/n3/libdispatch/dattget.c:318: warning: argument 'value' from the argument list of nc_get_att_uchar has multiple @param documentation sections
make[1]: Leaving directory '/home/ed/n3/docs'

@edwardhartnett
Copy link
Contributor Author

There are many warnings for filters.md, but I must wait until #2348 is merged before fixing them...

@edwardhartnett
Copy link
Contributor Author

OK, with the recent merges, there are no more warnings. Once #2377 and #2365 are done, only warning-free doxygen source will be merged.

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