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

Docs broken #252

Open
Kitzunu opened this issue Feb 3, 2025 · 1 comment
Open

Docs broken #252

Kitzunu opened this issue Feb 3, 2025 · 1 comment
Assignees
@r-o-b-o-t-o
Labels
documentation Improvements or additions to documentation

Comments

@Kitzunu
Copy link
Member

Kitzunu commented Feb 3, 2025

Docs build is broken resulting in /eluna not being updated daily.
@Kitzunu Kitzunu added the documentation Improvements or additions to documentation label Feb 3, 2025
@r-o-b-o-t-o
Copy link
Member

@iThorgrim

mod-eluna/src/LuaEngine/methods/GuildMethods.h

Lines 297 to 299 in a261c1c

* @param minLevel = the required min level
* @param maxLevel = the required max level
* @param minRank = the required min rank

These 3 params are missing a type, it's breaking the docs. Should be @param uint32 minLevel : the required min level and so on
Keep in mind the = sign is for specifying the default value, use : for the description.

Also remember to use [square brackets] around class types in order to enable hyperlinks: @param Player player = who sends the invitation should be @param [Player] player : who sends the invitation

@iThorgrim iThorgrim mentioned this issue Feb 5, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@r-o-b-o-t-o r-o-b-o-t-o

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@r-o-b-o-t-o @Kitzunu