1
0
Fork 0
mirror of https://github.com/juce-framework/JUCE.git synced 2026-01-10 23:44:24 +00:00

Docs: Fix some missing Doxygen tags

This commit is contained in:
Tom Poole 2023-10-20 11:19:15 +01:00
parent 82bc9f3195
commit c474cb2469
10 changed files with 23 additions and 18 deletions

View file

@ -31,7 +31,6 @@ namespace juce::detail
// Implemented in juce_Messaging_linux.cpp
bool dispatchNextMessageOnSystemQueue (bool returnIfNoPendingMessages);
/** @internal */
class MessageThread : public Thread
{
public:
@ -84,7 +83,6 @@ private:
};
//==============================================================================
/** @internal */
class HostDrivenEventLoop
{
public:

View file

@ -746,6 +746,9 @@ private:
} // namespace
namespace detail
{
void MimeTypeTable::registerCustomMimeTypeForFileExtension (const String& mimeType, const String& fileExtension)
{
Table::get().addEntry ({ fileExtension.toRawUTF8(), mimeType.toRawUTF8() });
@ -761,4 +764,6 @@ StringArray MimeTypeTable::getFileExtensionsForMimeType (const String& mimeType)
return Table::get().getExtensionsForType (mimeType);
}
} // namespace detail
} // namespace juce

View file

@ -25,20 +25,16 @@
#pragma once
namespace juce
namespace juce::detail
{
/** @internal */
struct MimeTypeTable
{
/** @internal */
static void registerCustomMimeTypeForFileExtension (const String& mimeType, const String& fileExtension);
static void registerCustomMimeTypeForFileExtension (const String& mimeType, const String& fileExtension);
/** @internal */
static StringArray getMimeTypesForFileExtension (const String& fileExtension);
static StringArray getMimeTypesForFileExtension (const String& fileExtension);
/** @internal */
static StringArray getFileExtensionsForMimeType (const String& mimeType);
static StringArray getFileExtensionsForMimeType (const String& mimeType);
};
} // namespace juce
} // namespace juce::detail

View file

@ -508,6 +508,8 @@ struct VariantConverter<String>
template <>
struct juce::VariantConverter<MyType> : public juce::StrictVariantConverter<MyType> {};
@endcode
@tags{Core}
*/
template <typename Type>
struct StrictVariantConverter

View file

@ -208,6 +208,8 @@ constexpr bool exactlyEqual (Type a, Type b)
/** A class encapsulating both relative and absolute tolerances for use in floating-point comparisons.
@see approximatelyEqual, absoluteTolerance, relativeTolerance
@tags{Core}
*/
template <typename Type>
class Tolerance

View file

@ -70,6 +70,8 @@ template <typename Fn> ScopeGuard (Fn) -> ScopeGuard<Fn>;
- Moving a unique_ptr transfers the responsibility of destroying the managed object
to another unique_ptr instance; moving an ErasedScopeGuard transfers the
responsibility of calling the callback to another Guard instance.
@tags{Core}
*/
class [[nodiscard]] ErasedScopeGuard
{

View file

@ -621,12 +621,12 @@ struct AndroidDocument::Utils
public:
static String getMimeTypeFromExtension (const String& str)
{
return MimeTypeTable::getMimeTypesForFileExtension (str)[0];
return detail::MimeTypeTable::getMimeTypesForFileExtension (str)[0];
}
static String getExtensionFromMimeType (const String& str)
{
return MimeTypeTable::getFileExtensionsForMimeType (str)[0];
return detail::MimeTypeTable::getFileExtensionsForMimeType (str)[0];
}
};
#endif

View file

@ -26,7 +26,7 @@
namespace juce::detail
{
/** Keeps track of the active top level window. */
/* Keeps track of the active top level window. */
class TopLevelWindowManager : private Timer,
private DeletedAtShutdown
{

View file

@ -482,7 +482,7 @@ private:
if (extension.isEmpty())
return nullptr;
return juceStringArrayToJava (filterMimeTypes (MimeTypeTable::getMimeTypesForFileExtension (extension), juceString (mimeTypeFilter.get())));
return juceStringArrayToJava (filterMimeTypes (detail::MimeTypeTable::getMimeTypesForFileExtension (extension), juceString (mimeTypeFilter.get())));
}
std::unique_ptr<ActivityLauncher> doIntent (const LocalRef<jobject>& intent,
@ -776,7 +776,7 @@ private:
if (std::none_of (extensions.begin(), extensions.end(), [] (const String& s) { return s.isEmpty(); }))
for (const auto& extension : extensions)
for (const auto& mime : MimeTypeTable::getMimeTypesForFileExtension (extension))
for (const auto& mime : detail::MimeTypeTable::getMimeTypesForFileExtension (extension))
mimes.insert (mime);
for (const auto& mime : mimes)

View file

@ -240,7 +240,7 @@ public:
{
auto extension = wildcard.fromLastOccurrenceOf (".", false, false);
result.addArray (MimeTypeTable::getMimeTypesForFileExtension (extension));
result.addArray (detail::MimeTypeTable::getMimeTypesForFileExtension (extension));
}
}
@ -280,7 +280,7 @@ bool FileChooser::isPlatformDialogAvailable()
void FileChooser::registerCustomMimeTypeForFileExtension (const String& mimeType,
const String& fileExtension)
{
MimeTypeTable::registerCustomMimeTypeForFileExtension (mimeType, fileExtension);
detail::MimeTypeTable::registerCustomMimeTypeForFileExtension (mimeType, fileExtension);
}
} // namespace juce