search

cds-astro / cds-healpix-java

The CDS HEALPix library in Java
BSD 3-Clause "New" or "Revised" License
9 stars 9 forks source link

Troubles generating the API documentation #1

Closed mreineck closed 5 years ago

mreineck commented 5 years ago

This is probably a newbie mistake, since I haven't worked with Java for a long time...

When running ant make.doc, I'm getting the following errors (and no HTML documentation):

martin@debian:~/codes/cds-healpix-java$ ant make.doc
Buildfile: /home/martin/codes/cds-healpix-java/build.xml

clean.doc:
     [echo] Clean dir: "/home/martin/codes/cds-healpix-java/target/docs/apidocs"...

doc:
     [echo] Create JavaDoc from "/home/martin/codes/cds-healpix-java/src/main/java" to "/home/martin/codes/cds-healpix-java/target/docs/apidocs"...
  [javadoc] Generating Javadoc
  [javadoc] Javadoc execution
  [javadoc] Loading source files for package cds.healpix...
  [javadoc] Loading source files for package cds.healpix.common...
  [javadoc] Loading source files for package cds.healpix.common.math...
  [javadoc] Loading source files for package cds.healpix.common.sphgeom...
  [javadoc] Loading source files for package cds.healpix.fillingcurve...
  [javadoc] /home/martin/codes/cds-healpix-java/src/main/java/cds/healpix/NeighbourList.java:1: error: unmappable character (0xC3) for encoding US-ASCII
  [javadoc] // Copyright 2017-2018 - Universit?? de Strasbourg/CNRS
  [javadoc]                                   ^
  [javadoc] /home/martin/codes/cds-healpix-java/src/main/java/cds/healpix/NeighbourList.java:1: error: unmappable character (0xA9) for encoding US-ASCII
  [javadoc] // Copyright 2017-2018 - Universit?? de Strasbourg/CNRS

... and so on.

Apparently my setup is not sufficiently francophone ;) Any tips how to fix this?

fxpineau commented 5 years ago

I removed the 'é' automatically added to the class headers. I hope it solves the problem, but it is hard to test from my computer.

I added the Javadoc into git (and the link to the Javadoc in the README.md file).

mreineck commented 5 years ago

I have opened PR #2 fixing the problem on the javadoc side. So in principle it should be possible to revert the patch you made and re-enable the 'é's.

fxpineau commented 5 years ago

Accents often cause troubles, so I prefer to completely remove them. I nevertheless accepted the commit.