Skip to content

doc: replace dead/outdated links + use doxygen comment in src/nuklear_math.c#976

Open
sleeptightAnsiC wants to merge 2 commits into
Immediate-Mode-UI:masterfrom
sleeptightAnsiC:doc_dead_links
Open

doc: replace dead/outdated links + use doxygen comment in src/nuklear_math.c#976
sleeptightAnsiC wants to merge 2 commits into
Immediate-Mode-UI:masterfrom
sleeptightAnsiC:doc_dead_links

Conversation

@sleeptightAnsiC

Copy link
Copy Markdown
Contributor

I was reading about Nuklear's internal math and realized the links are completely dead. Decided to clean this up a bit: 1st commit goes through all dead/outdated links and replaces them with archived/newer ones; 2nd commit updates the section under src/nuklear_math.c to proper Doxygen comment.

Having section about internal details in public documentation is probably not the best but I guess this is a useful information too. If someone gets confused about that page, I'll try improving it later. For now I just want to preserve old stuff.

DO NOT SQUASH

Several links were either dead, redirecting to different pages,
displaying 404 or entirely different content. This patch replaces
them with alive/new/archived ones in order to preserve information.
This was the last place in the library that used old /// comments.
I updated it in order to keep it consistent with everything else.
It probably doesn't make sense for internal details to appear in public
documentation, but I will worry about this later...
Comment thread demo/allegro5/Readme.md
Information on how to implement soft keyboard callbacks for Android can be on the Allegro community wiki:
https://web.archive.org/web/20160722031953/https://wiki.allegro.cc/index.php?title=Running_Allegro_applications_on_Android#Displaying_the_Android_keyboard

To display a soft keyboard on iOS, you must create a `UIView` subclass that implements the `UIKeyInput` interface. See `KeyboardHandleriOS.h` and `KeyboardHandleriOS.m` Objective-C source code files for an example on how to do this. As the Allegro keyboard driver does not currently listen for iOS events, we use a custom event emitter to emit keyboard events, which is passed in after initialization with `(void)setCustomKeyboardEventSource:(ALLEGRO_EVENT_SOURCE *)ev_src`. This causes normal keyboard events to be emitted and properly caught by the nuklear backend. The provided `main.c` demo file does not implement this, but with the provided source code files it is not difficult to do. See this Allegro community forum thread for more information: https://www.allegro.cc/forums/thread/616672

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://www.allegro.cc/forums/thread/616672

I tried my best to preserve that link, but even Wayback machine cannot resolve it. That's quite sad tbh... Maybe the server will come back someday

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants