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.

Sign up for GitHub

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

Jump to bottom

Doxygen doc overhaul #2659

Merged
merged 42 commits into from
Apr 9, 2022
Merged

Doxygen doc overhaul #2659

merged 42 commits into from
Apr 9, 2022

Conversation

ohlidalp
Copy link
Member

@ohlidalp ohlidalp commented Jan 23, 2021 •
edited
Loading

I updated the looks (doxygen-awesome) and placed my overwiew text on the main page.

image

@ohlidalp ohlidalp changed the title Added overview page to doxygen doc Doxygen doc overhaul Feb 24, 2022
@ohlidalp ohlidalp marked this pull request as ready for review February 24, 2022 00:29
@Zentro
Copy link
Member

Zentro commented Feb 24, 2022

Is there somewhere published that this can be viewed? @only-a-ptr

@AnotherFoxGuy
Copy link
Member

@Zentro Is there somewhere published that this can be viewed?

Here is a preview: https://test.anotherfoxguy.com/

@ohlidalp
Copy link
Member Author

ohlidalp commented Feb 24, 2022 •
edited
Loading

@AnotherFoxGuy thanks!
@Zentro I'd like you to publish it as http://developer.rigsofrods.org/, ideally with versioning like OGRE does: /latest for latest release, /VERSION for previous releases and as an added feat, /nightly for current master branch.

Zentro
Zentro requested changes Feb 24, 2022
View reviewed changes
doc/doxygen/MainPage.h Show resolved Hide resolved
@Zentro
Copy link
Member

Zentro commented Feb 24, 2022

@AnotherFoxGuy thanks! @Zentro I'd like you to publish it as http://developer.rigsofrods.org/, ideally with versioning like OGRE does: /latest for latest release, /VERSION for previous releases and as an added feat, /nightly for current master branch.

Will do.

@ohlidalp
Copy link
Member Author

ohlidalp commented Feb 26, 2022 •
edited
Loading

Guys, I need your opinions - does this make sense? cf12baf

I'm trying to document 4 different things in a single doxygen doc:

  • the codebase
  • angelscript API exposed by game to scripts (Script2Game)
  • angelscript callbacks which the game finds and invokes in scripts (Game2Script)
  • angelscript features from builtin scripts (Script2Script) - currently it's just raceManager, but there will be more.

Is it clear what is what?

@tritonas00
Copy link
Collaborator

makes sense

@Zentro
Copy link
Member

Zentro commented Feb 28, 2022

Makes sense for me too.

@ohlidalp
📚 Doxygen: added codebase overview page
8294a7d
@ohlidalp
📚 Doxygen overview: added audio, fs, message queue, cvars
5744edf
@ohlidalp
📚 Doxygen overview: added modcache
3120940
@ohlidalp
📚 Doxy overview: added console cmd, terrn, odef, tobj, script
423423d
@ohlidalp
📚 Doxygen: cover also angelscript, audio and network
611a95c
@ohlidalp
📚 Doxygen/overview: network, GUI, sim, gfx
604162a
@ohlidalp
🗑️ Rem. dead source file FileSystemInfo.h
69670fb 
Leftover from RigEditor era, circa 2014-15
@ohlidalp
📚 Doxygen: excluded DearIMGUI source files.
3e554a2
@ohlidalp
🗑️ Removed dead MyGUI helper sources.
02b55c4
@ohlidalp
🎨 Doxygen: changed theme to blue, applied doxygen-awesome.css
aff7ab3
@ohlidalp
👼 Merged angelscript doc into codebase Doxygen.
76a0aff 
Introduced faux namespace ScriptAPI and faux module 'Script-side API'
@ohlidalp
📚 Doxygen: added Console & Console commands modules.
7b08592
@ohlidalp
🗑️ Doxygen: removed stray OGRE module.
e74c858
@ohlidalp
📚 Doxygen: +Gameplay {Land vehicles, Aerial, Marine, Character}
a884d34
@ohlidalp
📚 Doxygen: added module Audio
913a29d
@ohlidalp
📚 Doxygen: code overview is now on mainpage.
c1c0a83
@ohlidalp
📚 Doxygen: added module Terrain
ee6525d
@ohlidalp
🗑️ Rem. unused source files DecalManager.h/cpp
3520528
@ohlidalp
📚 Doxygen: + modules Gfx, Hydrax, Flex
2b643bf
@ohlidalp
🧹 Doxygen: Consolidated @defgroup commands to 'Modules.h'.
a2b872a 
Also fixed many 'missing title' warnings.
Also fixed INPUT tag.
@ohlidalp
👼 Added doc for callbacks and races.
53b0b5f 
The angelscript documentation is now divided into 3 pseudo-modules:

 	Game-to-script
 	^AngelScript^ Documents script functions (callbacks) invoked by the game.

 	Script-to-game
 	^AngelScript^ Documents game functions which scripts can invoke to control it.

 	Script-to-script
 	^AngelScript^ Documents built-in scripts.
@ohlidalp
📚 Doxygen: fixed most warnings.
82f14aa
@ohlidalp
📚 Doxygen: added module 'Scripting'.
27f3a45
@ohlidalp
📚 Doxygen: Added module 'network'.
53285fa
@ohlidalp
Doxygen: added script APIref link to mainpage.
c3c8752
@ohlidalp
Doxygen: added missing @defgroup-s, improved formatting.
b770465
@ohlidalp
Doxygen: added module Camera
81cb631
@ohlidalp
Doxygen: added module Gfx/Particle, fixed warnings, added override …
89a7ac7 
…keyword.

There were many broken @copydoc/@Copyref directives - removed in favor of simple member group explaining where the API is from.
@ohlidalp
Doxygen: Organized directory 'utils/', added module Input.
d32ab51
@ohlidalp
🗑️ Del. unused trimUTFString()
7dce805
@ohlidalp
Doxygen: fixed 'no matching item found' warnings.
ff715ac
@ohlidalp
Doxygen: fixed a lot of warnings
5db9c58 
Redundant docs simply deleted.
GUi_GameControls: deleted unused variable `m_text_all_active` - leftover from removed .map file combobox.
@ohlidalp ohlidalp requested a review from Zentro April 8, 2022 21:45
@ohlidalp ohlidalp merged commit c980fcd into RigsOfRods:master Apr 9, 2022
@ohlidalp ohlidalp deleted the doxy branch April 9, 2022 12:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tritonas00 tritonas00 tritonas00 approved these changes

@Zentro Zentro Zentro approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@ohlidalp @Zentro @AnotherFoxGuy @tritonas00