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

[WIP] document usage better #163

Merged
merged 4 commits into from
Apr 28, 2020
Merged

[WIP] document usage better #163

merged 4 commits into from
Apr 28, 2020

Conversation

zeratax
Copy link
Owner

@zeratax zeratax commented Apr 9, 2020

!fixes #74

c++ docs now go in docs/{html,latex}
and java into docs/java

maybe instead it should be docs/{java,cpp}?

and should we create a tiny html thingie so when you go to https://github.com/ZerataX/yacx
you get an overview over yacx and then you can pick if you want the cpp or the java docs?

kinda sad to remove my super cool makefiles, but really makes no sense to have makefiles and cmake

probably also need to figure out includes better to make importing this project easier like the current
"yacx/Devices.hpp" works only with cmake I think? I guess that's fine, just never sure when I should use relative paths

@zeratax zeratax added the documentation Improvements or additions to documentation label Apr 9, 2020
@LukasSiefke
Copy link
Collaborator

Ich wäre für docs/{java,cpp}
Das mit dem Html-Dings kann man machen, ist aber denke ich nicht soo wichtig
Bei den includes bin ich mir auch immer unsicher. Beim JNI hatte ich dann immer den relativen Pfad mit ../../include/yacx/Klasse.cpp angegeben

@zeratax
Copy link
Owner Author

zeratax commented Apr 28, 2020

gonna do the import paths later, just want the readme to be somewhat clean for now

@zeratax zeratax merged commit 1fc418a into master Apr 28, 2020
@zeratax zeratax deleted the importextern branch April 28, 2020 01:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

doxygen ignore Java?
2 participants