Comments (12)
(by fabio-pasini)
Doc++ stuff got removed from makefile at
http://bazaar.launchpad.net/~stratagus/stratagus/trunk/revision/6744
Still hadn't time to check if that code still works with the latest doc++ version,
I can take a look next thursday - it's Carnival here in Brazil, and I don't have access to my ubuntu machine 'till end of the holydays.
[]'s
Tilpa
from stratagus.
(by fabio-pasini)
The makefile chunk related to doc++ as of revision 6744 doesn't work anymore :(
I'll make some more tests and post a patch here if I got something useful.
Folks, you think this issue doesn't worth a fix, just let me know.
[]'s
Tilpa
from stratagus.
(by pali)
Our static Makefile(s) will be replaced by CMake in future. So all changes in Makefile(s) will be deleted! If you want support doc++ please add rules to new CMake scripts.
Bzr branch for CMake build system: https://code.launchpad.net/~stratagus/stratagus/stratagus-cmake
When it be stable it will be merged into trunk.
from stratagus.
(by fabio-pasini)
Starting doc++ as described in the attached file
("generate_doc++.sh", run it from the same directory as makefile )
it spends a really long time eating 99% cpu before output the results.
I tried changing the input file order sequence etc, with the same results.
There are also other (unrelated) bugs
for current doc++ stable version (3.4.10, released on December 22, 2002),
e.g. http://www.lorene.obspm.fr/oldlist/2003-November/000012.html
My vote is to simply remove all doc++ references from files
~/src/stratagus/stratagus.cpp
~/doc/development.html,
and keep not using doc++.
In fact, I think that doxygen documentation looks way better than doc++ output.
from stratagus.
(by pali)
I think that doc++ nobody used. If doxygen works fine, doc++ could be deleted.
from stratagus.
(by pali)
Stratagus now using CMake build system. Doc++ support was dropped, CMake script support generating Doxygen documentation.
from stratagus.
(by fabio-pasini)
Make script support generating Doxygen documentation.
cmake is generating doxygen documantation properly
(as of revision 7953, great work, dudes!),
just a few more adjustments needed to reflect the new build mecanism:
Broken links:
- Files "/doc/index.html" states
"After Stratagus compilation can be found in the source code documentation",
but html link "source code documentation" points to the wrong place. - Also, file "/doc/development.html" states
"After compilation is availabe here"
but html link "here" points to the wrong place.
Question:
Should those links be corrected and point to "/build/doxygen/index.html",
or should cmake generate doxygen files into "doc/doxygen/" ?
(I do prefer the latter, but its up to you, guys :)
Document new usage:
- Doxygen files are generated only after set the option "ENABLE_DOC" to "ON"
inside file "CMakeLists.txt",
but that isn't mentioned anywere.
I believe it would be nice to enhance "/doc/development.html" and
some more details about where and how change the build scripts to have
doxygen stuff being created.
from stratagus.
(by pali)
-
and 2)
you need to run make install. it copy html files from doc and from buildir/doxygen. problem is that you can create build directory not only in <root_folder>/build and is not good idea to generate some files outside build directory...
I updated some info... but not all. and you can write detailed info too :)
from stratagus.
(by fabio-pasini)
and you can write detailed info too :)
You're right! :)
Please refer to file doc-proposed.tar.gz attached, I've included some more details about where find doxygen output, how generate it, and where configure it.
Those files are just a suggestion, feel free to change/adjust anything.
[]'s
from stratagus.
(by pali)
Note that editing Doxyfine.in is not good idea. It is template for CMake (CMake generate correct Doxyfile from Doxyfile.in)
And as I wrote you need to run make install (with ENABLE_DOC) for correct paths.
make install copy /doc and /doxygen to one install folder /share/doc/stratagus/
from stratagus.
(by fabio-pasini)
Note that editing Doxyfine.in is not good idea.
OK, removed.
.
need to run make install (with ENABLE_DOC) for correct paths.
You're right, but ... 'make install' is not referred anywhere :(
I believe 'make install' should be pointed inside install.htm,
but I'm not experienced enough to create docs for this part.
.
Added another proposal as attachment. Again, feel free to change/edit it as needed :)
[]'s
from stratagus.
(by pali)
Ok. Now I updated info in html files. See commit: http://bazaar.launchpad.net/~stratagus/stratagus/trunk/revision/7990
from stratagus.
Related Issues (20)
- AppImage for Stratagus and Stargus on Linux! HOT 8
- Crash on startup HOT 1
- Wargus Multiplayer crashing in 3.3.2 HOT 2
- Bug with the Extraction process? HOT 4
- 'Open' on lines 70,71,72 in astar.cpp prevents compiling HOT 2
- adding ultrawide resolutions HOT 2
- Crash at the end of the mission HOT 1
- Failed to load game data - Orc Campaign 6 (Sunnyglade Victory)
- Crash when starting second scenario, after Hillsbrad and briefing
- Screen flashes when starting new building construction HOT 3
- Possible LUA Editing/Modding Code Guide/Reference for Stratagus (WC1, WC2, SC1, etc) + Evidential Plans of Working (Pre-)Releases for Starcraft1/Stargus HOT 5
- [macOS] The Cmake HAS_17_FS test fails with Xcode 14.3 HOT 3
- ui/black_title.png not loading and crashing game
- custom UI artwork HOT 6
- Multiplayer on network won't allow non-host player to be Orc HOT 1
- Wargus 3.3.2 - Bug Extraction process HOT 5
- Wargus - Network out of sync in Single Player Campaign HOT 12
- building tolua.cpp.o: try to execute -L in sh HOT 1
- try to build with /usr/include/lua.h rather than /usr/include/lua-5.1/lua.h (I think) HOT 2
- Documentation typo/incorrect information? HOT 6
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from stratagus.