API-doc search not available / many content like jucePlatformDefs is missing / isPositiveAndBelow not findable about juce HOT 17 CLOSED

from juce.

Example:

https://www.juce.com/doc/classAudioProcessorEditor

"The AudioProcessorEditor class should inherit from the Component class, but under the label: "Inheritance Diagram for AudioProcessorEditor" it's empty and the label is not responsive despite being clickable."

from juce.

Previously mentioned Dec 2015 on forum:
https://forum.juce.com/t/please-bring-back-the-old-api-documentation/16185

from juce.

Possible quickfix:
In doxygen/Doxyfile set
HTML_DYNAMIC_SECTIONS = NO

That way the inheritance diagrams are shown always, better than never shown...

from juce.

The inheritance schemata are fixed now, thanks @tpoole! Makes understanding the structure of the API much easier.
Only the search is still missing.

from juce.

bumping the API doc search...

from juce.

API Doc search is still not available. Why is this not a priority?

from juce.

Another mention in the forum:
https://forum.juce.com/t/api-search/23721

from juce.

Defines like JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR is not visible on the Web-API-Docs at all.
The maths functions e.g. jmax, isPositiveAndBelow can only be found, if you already know, where they are.

from juce.

Linking some more issues from the forum:
jpo: https://forum.juce.com/t/documentation-urls-and-quick-access/23768/11
reFX: https://forum.juce.com/t/documentation-urls-and-quick-access/23768/13
Holy_City: https://forum.juce.com/t/documentation-urls-and-quick-access/23768/14

from juce.

from juce.

I'm prepared to create my own doxygen copy and even implement the search again AND make all that available to the public. Do I really need to install Python just to make that happen?

I think how ROLI/JUCE handles their documentation is outrageous and unacceptable. You want developers to use and license your code? Then maybe show us that you give a crap. Right now, almost all forum posts go unanswered.

ROLI still hasn't answered how they want to handle the "pro" support they promised.

from juce.

We don't care about fixing it? The recent changes are the first steps towards sorting things out...

from juce.

You broke it in the first place. Was anybody asking for these mega-pages?

How do you expect people to use the text-search in their browser to find anything related to the class they're looking for?

Why do you ignore complaints about the theme (colours and font-weights)?

How are any of the recent changes (anything that happened for the 5.0 release and after) an improvement in any way, shape or form?

You broke it. Made it harder to read and now made even the most basic browser-search unusable. If you left it like the last 4.x release, everybody would be much happier.

Here is my first attempt (!) after downloading doxygen and then playing with the css for two hours:

https://juce.refx.com/classSlider.html

All I literally did, was download your doxygen-config file, run it and then add a CSS file via the HTML_EXTRA_STYLESHEET setting. That's literally all I did. Doxygen already features a client-side search (not super-awesome, but better than nothing).

Everything is nicely structured and usable.

Please don't take this too personal. I'm just super-frustrated, because it got worse and worse and worse and then we got ignored. Apparently communication on GitHub works MUCH better than on the forum.

from juce.

And oh my god, it's readable!

Yeah, it's surprising what you can do when your font-weight isn't "light" or "extra-light" and your colours actually have contrast.

I'll massage it some more (as I notice stuff) and improve the CSS over the next few days.

from juce.

There really is no need for such vitriol.

You haven't been ignored - the recent changes to the documentation are, in fact, concrete evidence of the opposite.

Having multiple classes on a single page was a side effect of grouping the classes by module, and, as of a few minutes ago, the old single-class-per-page format has been restored.

The Doxygen search box is now present at the top of each page.

Things like isPositiveAndBelow are located at https://juce.com/doc/group__juce__core-maths.

from juce.

Thanks so much @tpoole !
This works now perfectly, more than I hoped for.
In the name of the community I want to apologise for all harsh words.

from juce.