From cdbc28c18bd091791cd2ed6d746d7ebdb4770c69 Mon Sep 17 00:00:00 2001 From: ed Date: Thu, 15 Mar 2018 10:47:05 +0000 Subject: [PATCH] Add documentation tags --- .../juce_analytics/analytics/juce_Analytics.h | 2 + .../analytics/juce_ButtonTracker.h | 2 + .../destinations/juce_AnalyticsDestination.h | 2 + .../juce_ThreadedAnalyticsDestination.h | 2 + .../audio_play_head/juce_AudioPlayHead.h | 2 + .../buffers/juce_AudioChannelSet.h | 2 + .../buffers/juce_AudioDataConverters.h | 4 ++ .../buffers/juce_AudioSampleBuffer.h | 2 + .../buffers/juce_FloatVectorOperations.h | 4 ++ .../effects/juce_CatmullRomInterpolator.h | 2 + .../juce_audio_basics/effects/juce_Decibels.h | 2 + .../effects/juce_IIRFilter.h | 4 ++ .../effects/juce_LagrangeInterpolator.h | 2 + .../effects/juce_LinearSmoothedValue.h | 4 +- .../juce_audio_basics/effects/juce_Reverb.h | 2 + .../juce_audio_basics/midi/juce_MidiBuffer.h | 2 + .../juce_audio_basics/midi/juce_MidiFile.h | 2 + .../midi/juce_MidiKeyboardState.h | 4 ++ .../juce_audio_basics/midi/juce_MidiMessage.h | 2 + .../midi/juce_MidiMessageSequence.h | 2 + modules/juce_audio_basics/midi/juce_MidiRPN.h | 6 +++ .../mpe/juce_MPEInstrument.h | 2 + .../juce_audio_basics/mpe/juce_MPEMessages.h | 2 + modules/juce_audio_basics/mpe/juce_MPENote.h | 2 + .../mpe/juce_MPESynthesiser.h | 2 + .../mpe/juce_MPESynthesiserBase.h | 2 + .../mpe/juce_MPESynthesiserVoice.h | 4 +- modules/juce_audio_basics/mpe/juce_MPEUtils.h | 4 ++ modules/juce_audio_basics/mpe/juce_MPEValue.h | 2 + .../mpe/juce_MPEZoneLayout.h | 2 + .../native/juce_mac_CoreAudioLayouts.h | 2 +- .../sources/juce_AudioSource.h | 4 ++ .../sources/juce_BufferingAudioSource.h | 2 + .../juce_ChannelRemappingAudioSource.h | 2 + .../sources/juce_IIRFilterAudioSource.h | 2 + .../sources/juce_MemoryAudioSource.h | 2 + .../sources/juce_MixerAudioSource.h | 2 + .../sources/juce_PositionableAudioSource.h | 2 + .../sources/juce_ResamplingAudioSource.h | 2 + .../sources/juce_ReverbAudioSource.h | 2 + .../sources/juce_ToneGeneratorAudioSource.h | 2 + .../synthesisers/juce_Synthesiser.h | 6 +++ .../audio_io/juce_AudioDeviceManager.h | 2 + .../audio_io/juce_AudioIODevice.h | 4 ++ .../audio_io/juce_AudioIODeviceType.h | 2 + .../audio_io/juce_SystemAudioVolume.h | 2 + .../midi_io/juce_MidiInput.h | 4 ++ .../midi_io/juce_MidiMessageCollector.h | 2 + .../midi_io/juce_MidiOutput.h | 2 + .../native/juce_MidiDataConcatenator.h | 2 + .../sources/juce_AudioSourcePlayer.h | 2 + .../sources/juce_AudioTransportSource.h | 2 + .../codecs/juce_AiffAudioFormat.h | 2 + .../codecs/juce_CoreAudioFormat.h | 4 +- .../codecs/juce_FlacAudioFormat.h | 2 + .../codecs/juce_LAMEEncoderAudioFormat.h | 2 + .../codecs/juce_MP3AudioFormat.h | 2 + .../codecs/juce_OggVorbisAudioFormat.h | 2 + .../codecs/juce_WavAudioFormat.h | 2 + .../codecs/juce_WindowsMediaAudioFormat.h | 2 + .../format/juce_AudioFormat.h | 2 + .../format/juce_AudioFormatManager.h | 2 + .../format/juce_AudioFormatReader.h | 2 + .../format/juce_AudioFormatReaderSource.h | 2 + .../format/juce_AudioFormatWriter.h | 7 ++- .../format/juce_AudioSubsectionReader.h | 2 + .../format/juce_BufferingAudioFormatReader.h | 2 + .../juce_MemoryMappedAudioFormatReader.h | 2 + .../juce_audio_formats/sampler/juce_Sampler.h | 4 ++ .../AAX/juce_AAX_Modifier_Injector.h | 4 ++ .../Standalone/juce_StandaloneFilterWindow.h | 5 ++ .../VST/juce_VSTCallbackHandler.h | 2 + .../utility/juce_FakeMouseMoveGenerator.h | 4 ++ .../utility/juce_PluginHostType.h | 2 + .../format/juce_AudioPluginFormat.h | 3 ++ .../format/juce_AudioPluginFormatManager.h | 2 + .../format_types/juce_AU_Shared.h | 4 ++ .../format_types/juce_AudioUnitPluginFormat.h | 2 + .../format_types/juce_LADSPAPluginFormat.h | 2 + .../format_types/juce_VST3PluginFormat.h | 2 + .../format_types/juce_VSTCommon.h | 6 +++ .../format_types/juce_VSTInterface.h | 44 ++++++++++++++++ .../format_types/juce_VSTMidiEventList.h | 2 + .../format_types/juce_VSTPluginFormat.h | 2 + .../processors/juce_AudioPluginInstance.h | 3 ++ .../processors/juce_AudioProcessor.h | 3 ++ .../processors/juce_AudioProcessorEditor.h | 2 + .../processors/juce_AudioProcessorGraph.h | 2 + .../processors/juce_AudioProcessorListener.h | 2 + .../processors/juce_AudioProcessorParameter.h | 2 + .../juce_GenericAudioProcessorEditor.h | 2 + .../processors/juce_PluginDescription.h | 2 + .../scanning/juce_KnownPluginList.h | 3 ++ .../scanning/juce_PluginDirectoryScanner.h | 2 + .../scanning/juce_PluginListComponent.h | 2 + .../utilities/juce_AudioParameterBool.h | 2 + .../utilities/juce_AudioParameterChoice.h | 2 + .../utilities/juce_AudioParameterFloat.h | 2 + .../utilities/juce_AudioParameterInt.h | 2 + .../juce_AudioProcessorParameterWithID.h | 2 + .../juce_AudioProcessorValueTreeState.h | 2 + .../audio_cd/juce_AudioCDBurner.h | 2 + .../audio_cd/juce_AudioCDReader.h | 2 + .../gui/juce_AudioAppComponent.h | 2 + .../gui/juce_AudioDeviceSelectorComponent.h | 2 + .../gui/juce_AudioThumbnail.h | 2 + .../gui/juce_AudioThumbnailBase.h | 2 + .../gui/juce_AudioThumbnailCache.h | 2 + .../gui/juce_AudioVisualiserComponent.h | 2 + .../juce_BluetoothMidiDevicePairingDialogue.h | 3 +- .../gui/juce_MidiKeyboardComponent.h | 2 + .../players/juce_AudioProcessorPlayer.h | 2 + .../players/juce_SoundPlayer.h | 2 + .../juce_blocks_basics/blocks/juce_Block.h | 2 + .../blocks/juce_BlockConfigManager.h | 5 ++ .../blocks/juce_ControlButton.h | 2 + .../juce_blocks_basics/blocks/juce_LEDGrid.h | 4 ++ .../juce_blocks_basics/blocks/juce_LEDRow.h | 2 + .../blocks/juce_StatusLight.h | 2 + .../blocks/juce_TouchList.h | 2 + .../blocks/juce_TouchSurface.h | 3 ++ .../littlefoot/juce_LittleFootCompiler.h | 7 +++ .../littlefoot/juce_LittleFootRemoteHeap.h | 2 + .../littlefoot/juce_LittleFootRunner.h | 9 +++- .../protocol/juce_BitPackingUtilities.h | 10 ++++ .../protocol/juce_BlockModels.h | 5 +- .../protocol/juce_BlocksProtocolDefinitions.h | 38 +++++++++++++- .../protocol/juce_HostPacketBuilder.h | 2 + .../protocol/juce_HostPacketDecoder.h | 2 + .../topology/juce_PhysicalTopologySource.h | 2 + .../topology/juce_RuleBasedTopologySource.h | 2 + .../topology/juce_Topology.h | 10 +++- .../topology/juce_TopologySource.h | 6 ++- .../visualisers/juce_BitmapLEDProgram.h | 2 + .../visualisers/juce_DrumPadLEDProgram.h | 1 + modules/juce_box2d/utils/juce_Box2DRenderer.h | 2 + .../juce_core/containers/juce_AbstractFifo.h | 3 ++ modules/juce_core/containers/juce_Array.h | 2 + .../containers/juce_ArrayAllocationBase.h | 2 + .../juce_core/containers/juce_DynamicObject.h | 2 + .../containers/juce_ElementComparator.h | 4 ++ modules/juce_core/containers/juce_HashMap.h | 4 ++ .../containers/juce_LinkedListPointer.h | 2 + .../juce_core/containers/juce_ListenerList.h | 2 + .../juce_core/containers/juce_NamedValueSet.h | 3 ++ .../juce_core/containers/juce_OwnedArray.h | 2 + .../juce_core/containers/juce_PropertySet.h | 2 + .../containers/juce_ReferenceCountedArray.h | 2 + .../containers/juce_ScopedValueSetter.h | 1 + modules/juce_core/containers/juce_SortedSet.h | 2 + modules/juce_core/containers/juce_SparseSet.h | 2 + modules/juce_core/containers/juce_Variant.h | 10 +++- .../juce_core/files/juce_DirectoryIterator.h | 2 + modules/juce_core/files/juce_File.h | 3 ++ modules/juce_core/files/juce_FileFilter.h | 2 + .../juce_core/files/juce_FileInputStream.h | 2 + .../juce_core/files/juce_FileOutputStream.h | 2 + modules/juce_core/files/juce_FileSearchPath.h | 2 + .../juce_core/files/juce_MemoryMappedFile.h | 2 + modules/juce_core/files/juce_TemporaryFile.h | 2 + .../juce_core/files/juce_WildcardFileFilter.h | 2 + modules/juce_core/javascript/juce_JSON.h | 2 + .../juce_core/javascript/juce_Javascript.h | 2 + modules/juce_core/logging/juce_FileLogger.h | 2 + modules/juce_core/logging/juce_Logger.h | 2 + modules/juce_core/maths/juce_BigInteger.h | 2 + modules/juce_core/maths/juce_Expression.h | 2 + modules/juce_core/maths/juce_MathsFunctions.h | 16 +++++- .../juce_core/maths/juce_NormalisableRange.h | 2 + modules/juce_core/maths/juce_Random.h | 2 + modules/juce_core/maths/juce_Range.h | 2 + .../maths/juce_StatisticsAccumulator.h | 2 + modules/juce_core/memory/juce_Atomic.h | 9 +++- modules/juce_core/memory/juce_ByteOrder.h | 2 + .../memory/juce_ContainerDeletePolicy.h | 2 + modules/juce_core/memory/juce_HeapBlock.h | 2 + .../memory/juce_LeakedObjectDetector.h | 2 + modules/juce_core/memory/juce_Memory.h | 2 + modules/juce_core/memory/juce_MemoryBlock.h | 2 + .../memory/juce_OptionalScopedPointer.h | 2 + .../memory/juce_ReferenceCountedObject.h | 6 +++ modules/juce_core/memory/juce_ScopedPointer.h | 2 + .../memory/juce_SharedResourcePointer.h | 4 +- modules/juce_core/memory/juce_Singleton.h | 2 + modules/juce_core/memory/juce_WeakReference.h | 2 + modules/juce_core/misc/juce_Result.h | 2 + .../juce_core/misc/juce_RuntimePermissions.h | 2 + .../juce_core/misc/juce_StdFunctionCompat.h | 5 +- modules/juce_core/misc/juce_Uuid.h | 2 + modules/juce_core/misc/juce_WindowsRegistry.h | 2 + .../juce_core/native/juce_win32_ComSmartPtr.h | 4 ++ modules/juce_core/network/juce_IPAddress.h | 2 + modules/juce_core/network/juce_MACAddress.h | 2 + modules/juce_core/network/juce_NamedPipe.h | 2 + modules/juce_core/network/juce_Socket.h | 4 ++ modules/juce_core/network/juce_URL.h | 3 ++ .../juce_core/network/juce_WebInputStream.h | 3 ++ .../streams/juce_BufferedInputStream.h | 2 + .../juce_core/streams/juce_FileInputSource.h | 2 + modules/juce_core/streams/juce_InputSource.h | 2 + modules/juce_core/streams/juce_InputStream.h | 2 + .../streams/juce_MemoryInputStream.h | 2 + .../streams/juce_MemoryOutputStream.h | 2 + modules/juce_core/streams/juce_OutputStream.h | 2 + .../juce_core/streams/juce_SubregionStream.h | 2 + modules/juce_core/system/juce_SystemStats.h | 2 + modules/juce_core/text/juce_Base64.h | 2 + .../juce_core/text/juce_CharPointer_ASCII.h | 2 + .../juce_core/text/juce_CharPointer_UTF16.h | 2 + .../juce_core/text/juce_CharPointer_UTF32.h | 2 + .../juce_core/text/juce_CharPointer_UTF8.h | 2 + .../juce_core/text/juce_CharacterFunctions.h | 3 ++ modules/juce_core/text/juce_Identifier.h | 2 + .../juce_core/text/juce_LocalisedStrings.h | 2 + modules/juce_core/text/juce_NewLine.h | 2 + modules/juce_core/text/juce_String.h | 4 +- modules/juce_core/text/juce_StringArray.h | 2 + modules/juce_core/text/juce_StringPairArray.h | 2 + modules/juce_core/text/juce_StringPool.h | 2 + modules/juce_core/text/juce_StringRef.h | 2 + modules/juce_core/text/juce_TextDiff.h | 2 + modules/juce_core/threads/juce_ChildProcess.h | 2 + .../juce_core/threads/juce_CriticalSection.h | 4 ++ .../juce_core/threads/juce_DynamicLibrary.h | 2 + .../threads/juce_HighResolutionTimer.h | 2 + .../juce_core/threads/juce_InterProcessLock.h | 2 + modules/juce_core/threads/juce_Process.h | 2 + .../juce_core/threads/juce_ReadWriteLock.h | 2 + modules/juce_core/threads/juce_ScopedLock.h | 6 +++ .../juce_core/threads/juce_ScopedReadLock.h | 2 + .../juce_core/threads/juce_ScopedWriteLock.h | 2 + modules/juce_core/threads/juce_SpinLock.h | 2 + modules/juce_core/threads/juce_Thread.h | 3 ++ .../juce_core/threads/juce_ThreadLocalValue.h | 2 + modules/juce_core/threads/juce_ThreadPool.h | 4 ++ .../juce_core/threads/juce_TimeSliceThread.h | 4 ++ .../juce_core/threads/juce_WaitableEvent.h | 2 + .../juce_core/time/juce_PerformanceCounter.h | 4 ++ modules/juce_core/time/juce_RelativeTime.h | 2 + modules/juce_core/time/juce_Time.h | 2 + modules/juce_core/unit_tests/juce_UnitTest.h | 4 ++ modules/juce_core/xml/juce_XmlDocument.h | 2 + modules/juce_core/xml/juce_XmlElement.h | 2 + .../zip/juce_GZIPCompressorOutputStream.h | 2 + .../zip/juce_GZIPDecompressorInputStream.h | 2 + modules/juce_core/zip/juce_ZipFile.h | 2 + .../encryption/juce_BlowFish.h | 2 + .../encryption/juce_Primes.h | 2 + .../encryption/juce_RSAKey.h | 2 + modules/juce_cryptography/hashing/juce_MD5.h | 2 + .../juce_cryptography/hashing/juce_SHA256.h | 2 + .../hashing/juce_Whirlpool.h | 2 + .../juce_ApplicationProperties.h | 2 + .../app_properties/juce_PropertiesFile.h | 3 ++ .../undomanager/juce_UndoManager.h | 2 + .../undomanager/juce_UndoableAction.h | 2 + .../values/juce_CachedValue.h | 2 + .../juce_data_structures/values/juce_Value.h | 2 + .../values/juce_ValueTree.h | 2 + .../values/juce_ValueTreeSynchroniser.h | 2 + .../values/juce_ValueWithDefault.h | 2 + modules/juce_dsp/containers/juce_AudioBlock.h | 2 + .../juce_dsp/containers/juce_SIMDRegister.h | 4 ++ .../filter_design/juce_FilterDesign.h | 2 + modules/juce_dsp/frequency/juce_Convolution.h | 2 + modules/juce_dsp/frequency/juce_FFT.h | 2 + modules/juce_dsp/frequency/juce_Windowing.h | 2 + .../maths/juce_FastMathApproximations.h | 2 + modules/juce_dsp/maths/juce_LookupTable.h | 4 ++ modules/juce_dsp/maths/juce_Matrix.h | 2 + modules/juce_dsp/maths/juce_Phase.h | 2 + modules/juce_dsp/maths/juce_Polynomial.h | 2 + .../juce_dsp/maths/juce_SpecialFunctions.h | 2 + .../juce_dsp/native/juce_avx_SIMDNativeOps.h | 50 +++++++++++++++---- .../native/juce_fallback_SIMDNativeOps.h | 2 + .../juce_dsp/native/juce_neon_SIMDNativeOps.h | 47 +++++++++++++---- .../juce_dsp/native/juce_sse_SIMDNativeOps.h | 50 +++++++++++++++---- modules/juce_dsp/processors/juce_Bias.h | 2 + modules/juce_dsp/processors/juce_FIRFilter.h | 4 ++ modules/juce_dsp/processors/juce_Gain.h | 2 + modules/juce_dsp/processors/juce_IIRFilter.h | 11 ++-- .../juce_dsp/processors/juce_LadderFilter.h | 2 + modules/juce_dsp/processors/juce_Oscillator.h | 2 + .../juce_dsp/processors/juce_Oversampling.h | 4 ++ .../juce_dsp/processors/juce_ProcessContext.h | 8 +++ .../processors/juce_ProcessorDuplicator.h | 2 + .../processors/juce_ProcessorWrapper.h | 4 ++ modules/juce_dsp/processors/juce_Reverb.h | 2 + .../processors/juce_StateVariableFilter.h | 28 +++++++---- modules/juce_dsp/processors/juce_WaveShaper.h | 2 + .../broadcasters/juce_ActionBroadcaster.h | 2 + .../broadcasters/juce_ActionListener.h | 2 + .../broadcasters/juce_AsyncUpdater.h | 2 + .../broadcasters/juce_ChangeBroadcaster.h | 2 + .../broadcasters/juce_ChangeListener.h | 2 + .../interprocess/juce_ConnectedChildProcess.h | 4 ++ .../juce_InterprocessConnection.h | 2 + .../juce_InterprocessConnectionServer.h | 2 + .../messages/juce_ApplicationBase.h | 2 + .../messages/juce_CallbackMessage.h | 2 + .../messages/juce_DeletedAtShutdown.h | 2 + .../messages/juce_Initialisation.h | 2 + modules/juce_events/messages/juce_Message.h | 2 + .../messages/juce_MessageListener.h | 2 + .../messages/juce_MessageManager.h | 4 ++ .../juce_MountedVolumeListChangeDetector.h | 2 + modules/juce_events/timers/juce_MultiTimer.h | 2 + modules/juce_events/timers/juce_Timer.h | 2 + modules/juce_graphics/colour/juce_Colour.h | 2 + .../colour/juce_ColourGradient.h | 2 + modules/juce_graphics/colour/juce_Colours.h | 2 + modules/juce_graphics/colour/juce_FillType.h | 2 + .../juce_graphics/colour/juce_PixelFormats.h | 6 +++ .../contexts/juce_GraphicsContext.h | 2 + .../contexts/juce_LowLevelGraphicsContext.h | 2 + .../juce_LowLevelGraphicsPostScriptRenderer.h | 2 + .../juce_LowLevelGraphicsSoftwareRenderer.h | 2 + .../effects/juce_DropShadowEffect.h | 4 ++ .../juce_graphics/effects/juce_GlowEffect.h | 2 + .../effects/juce_ImageEffectFilter.h | 2 + .../fonts/juce_AttributedString.h | 2 + .../juce_graphics/fonts/juce_CustomTypeface.h | 2 + modules/juce_graphics/fonts/juce_Font.h | 2 + .../fonts/juce_GlyphArrangement.h | 4 ++ modules/juce_graphics/fonts/juce_TextLayout.h | 2 + modules/juce_graphics/fonts/juce_Typeface.h | 2 + .../geometry/juce_AffineTransform.h | 2 + .../juce_graphics/geometry/juce_BorderSize.h | 2 + .../juce_graphics/geometry/juce_EdgeTable.h | 2 + modules/juce_graphics/geometry/juce_Line.h | 2 + .../geometry/juce_Parallelogram.h | 2 + modules/juce_graphics/geometry/juce_Path.h | 2 + .../geometry/juce_PathIterator.h | 2 + .../geometry/juce_PathStrokeType.h | 2 + modules/juce_graphics/geometry/juce_Point.h | 2 + .../juce_graphics/geometry/juce_Rectangle.h | 2 + .../geometry/juce_RectangleList.h | 2 + modules/juce_graphics/images/juce_Image.h | 11 ++++ .../juce_graphics/images/juce_ImageCache.h | 2 + .../images/juce_ImageConvolutionKernel.h | 2 + .../images/juce_ImageFileFormat.h | 8 +++ .../native/juce_RenderingHelpers.h | 14 +++++- .../placement/juce_Justification.h | 2 + .../placement/juce_RectanglePlacement.h | 2 + .../application/juce_Application.h | 2 + .../buttons/juce_ArrowButton.h | 2 + modules/juce_gui_basics/buttons/juce_Button.h | 2 + .../buttons/juce_DrawableButton.h | 2 + .../buttons/juce_HyperlinkButton.h | 2 + .../buttons/juce_ImageButton.h | 2 + .../buttons/juce_ShapeButton.h | 2 + .../juce_gui_basics/buttons/juce_TextButton.h | 2 + .../buttons/juce_ToggleButton.h | 2 + .../buttons/juce_ToolbarButton.h | 2 + .../commands/juce_ApplicationCommandInfo.h | 2 + .../commands/juce_ApplicationCommandManager.h | 4 ++ .../commands/juce_ApplicationCommandTarget.h | 2 + .../commands/juce_KeyPressMappingSet.h | 2 + .../components/juce_CachedComponentImage.h | 2 + .../components/juce_Component.h | 2 + .../components/juce_ComponentListener.h | 2 + .../juce_gui_basics/components/juce_Desktop.h | 5 ++ .../components/juce_ModalComponentManager.h | 4 ++ .../juce_gui_basics/drawables/juce_Drawable.h | 2 + .../drawables/juce_DrawableComposite.h | 2 + .../drawables/juce_DrawableImage.h | 2 + .../drawables/juce_DrawablePath.h | 2 + .../drawables/juce_DrawableRectangle.h | 2 + .../drawables/juce_DrawableShape.h | 2 + .../drawables/juce_DrawableText.h | 2 + .../filebrowser/juce_ContentSharer.h | 2 + .../juce_DirectoryContentsDisplayComponent.h | 2 + .../filebrowser/juce_DirectoryContentsList.h | 2 + .../filebrowser/juce_FileBrowserComponent.h | 2 + .../filebrowser/juce_FileBrowserListener.h | 2 + .../filebrowser/juce_FileChooser.h | 2 + .../filebrowser/juce_FileChooserDialogBox.h | 2 + .../filebrowser/juce_FileListComponent.h | 2 + .../filebrowser/juce_FilePreviewComponent.h | 2 + .../juce_FileSearchPathListComponent.h | 2 + .../filebrowser/juce_FileTreeComponent.h | 2 + .../filebrowser/juce_FilenameComponent.h | 4 ++ .../filebrowser/juce_ImagePreviewComponent.h | 2 + .../keyboard/juce_CaretComponent.h | 2 + .../keyboard/juce_KeyListener.h | 2 + .../juce_gui_basics/keyboard/juce_KeyPress.h | 2 + .../keyboard/juce_KeyboardFocusTraverser.h | 2 + .../keyboard/juce_ModifierKeys.h | 2 + .../keyboard/juce_SystemClipboard.h | 2 + .../keyboard/juce_TextEditorKeyMapper.h | 2 + .../keyboard/juce_TextInputTarget.h | 2 + .../layout/juce_AnimatedPosition.h | 2 + .../layout/juce_AnimatedPositionBehaviours.h | 4 ++ .../layout/juce_ComponentAnimator.h | 2 + .../layout/juce_ComponentBoundsConstrainer.h | 2 + .../layout/juce_ComponentBuilder.h | 2 + .../layout/juce_ComponentMovementWatcher.h | 2 + .../layout/juce_ConcertinaPanel.h | 2 + modules/juce_gui_basics/layout/juce_FlexBox.h | 2 + .../juce_gui_basics/layout/juce_FlexItem.h | 2 + modules/juce_gui_basics/layout/juce_Grid.h | 2 + .../juce_gui_basics/layout/juce_GridItem.h | 2 + .../layout/juce_GroupComponent.h | 2 + .../layout/juce_MultiDocumentPanel.h | 4 ++ .../layout/juce_ResizableBorderComponent.h | 2 + .../layout/juce_ResizableCornerComponent.h | 2 + .../layout/juce_ResizableEdgeComponent.h | 2 + .../juce_gui_basics/layout/juce_ScrollBar.h | 2 + .../juce_gui_basics/layout/juce_SidePanel.h | 5 +- .../layout/juce_StretchableLayoutManager.h | 2 + .../layout/juce_StretchableLayoutResizerBar.h | 2 + .../layout/juce_StretchableObjectResizer.h | 2 + .../layout/juce_TabbedButtonBar.h | 4 ++ .../layout/juce_TabbedComponent.h | 2 + .../juce_gui_basics/layout/juce_Viewport.h | 2 + .../lookandfeel/juce_LookAndFeel.h | 4 ++ .../lookandfeel/juce_LookAndFeel_V1.h | 2 + .../lookandfeel/juce_LookAndFeel_V2.h | 2 + .../lookandfeel/juce_LookAndFeel_V3.h | 2 + .../lookandfeel/juce_LookAndFeel_V4.h | 2 + .../menus/juce_BurgerMenuComponent.h | 3 +- .../menus/juce_MenuBarComponent.h | 2 + .../juce_gui_basics/menus/juce_MenuBarModel.h | 2 + .../juce_gui_basics/menus/juce_PopupMenu.h | 2 + .../misc/juce_BubbleComponent.h | 2 + .../juce_gui_basics/misc/juce_DropShadower.h | 2 + .../misc/juce_JUCESplashScreen.h | 2 + .../mouse/juce_ComponentDragger.h | 2 + .../mouse/juce_DragAndDropContainer.h | 2 + .../mouse/juce_DragAndDropTarget.h | 2 + .../mouse/juce_FileDragAndDropTarget.h | 2 + .../mouse/juce_LassoComponent.h | 4 ++ .../juce_gui_basics/mouse/juce_MouseCursor.h | 2 + .../juce_gui_basics/mouse/juce_MouseEvent.h | 6 +++ .../mouse/juce_MouseInactivityDetector.h | 2 + .../mouse/juce_MouseInputSource.h | 2 + .../mouse/juce_MouseListener.h | 2 + .../mouse/juce_SelectedItemSet.h | 2 + .../mouse/juce_TextDragAndDropTarget.h | 2 + .../mouse/juce_TooltipClient.h | 4 ++ .../juce_gui_basics/native/juce_linux_X11.h | 7 ++- .../positioning/juce_MarkerList.h | 2 + .../positioning/juce_RelativeCoordinate.h | 3 ++ .../juce_RelativeCoordinatePositioner.h | 2 + .../positioning/juce_RelativeParallelogram.h | 2 + .../positioning/juce_RelativePoint.h | 2 + .../positioning/juce_RelativePointPath.h | 7 +++ .../positioning/juce_RelativeRectangle.h | 2 + .../juce_BooleanPropertyComponent.h | 2 + .../properties/juce_ButtonPropertyComponent.h | 2 + .../properties/juce_ChoicePropertyComponent.h | 2 + .../properties/juce_PropertyComponent.h | 2 + .../properties/juce_PropertyPanel.h | 2 + .../properties/juce_SliderPropertyComponent.h | 2 + .../properties/juce_TextPropertyComponent.h | 3 ++ .../juce_gui_basics/widgets/juce_ComboBox.h | 2 + .../widgets/juce_ImageComponent.h | 2 + modules/juce_gui_basics/widgets/juce_Label.h | 2 + .../juce_gui_basics/widgets/juce_ListBox.h | 4 ++ .../widgets/juce_ProgressBar.h | 2 + modules/juce_gui_basics/widgets/juce_Slider.h | 3 ++ .../widgets/juce_TableHeaderComponent.h | 2 + .../widgets/juce_TableListBox.h | 4 ++ .../juce_gui_basics/widgets/juce_TextEditor.h | 2 + .../juce_gui_basics/widgets/juce_Toolbar.h | 2 + .../widgets/juce_ToolbarItemComponent.h | 2 + .../widgets/juce_ToolbarItemFactory.h | 2 + .../widgets/juce_ToolbarItemPalette.h | 2 + .../juce_gui_basics/widgets/juce_TreeView.h | 4 ++ .../windows/juce_AlertWindow.h | 2 + .../juce_gui_basics/windows/juce_CallOutBox.h | 2 + .../windows/juce_ComponentPeer.h | 3 ++ .../windows/juce_DialogWindow.h | 2 + .../windows/juce_DocumentWindow.h | 2 + .../windows/juce_NativeMessageBox.h | 2 + .../windows/juce_ResizableWindow.h | 2 + .../windows/juce_ThreadWithProgressWindow.h | 2 + .../windows/juce_TooltipWindow.h | 2 + .../windows/juce_TopLevelWindow.h | 2 + .../code_editor/juce_CPlusPlusCodeTokeniser.h | 2 + .../juce_CPlusPlusCodeTokeniserFunctions.h | 2 + .../code_editor/juce_CodeDocument.h | 2 + .../code_editor/juce_CodeEditorComponent.h | 4 ++ .../code_editor/juce_CodeTokeniser.h | 2 + .../code_editor/juce_LuaCodeTokeniser.h | 2 + .../code_editor/juce_XMLCodeTokeniser.h | 2 + .../documents/juce_FileBasedDocument.h | 2 + .../embedding/juce_ActiveXControlComponent.h | 2 + .../embedding/juce_AndroidViewComponent.h | 2 + .../embedding/juce_NSViewComponent.h | 2 + .../embedding/juce_UIViewComponent.h | 2 + .../embedding/juce_XEmbedComponent.h | 2 + .../misc/juce_AnimatedAppComponent.h | 2 + .../juce_gui_extra/misc/juce_AppleRemote.h | 2 + .../misc/juce_BubbleMessageComponent.h | 2 + .../juce_gui_extra/misc/juce_ColourSelector.h | 2 + .../misc/juce_KeyMappingEditorComponent.h | 2 + .../misc/juce_PreferencesPanel.h | 2 + .../misc/juce_PushNotifications.h | 2 + .../misc/juce_RecentlyOpenedFilesList.h | 2 + .../juce_gui_extra/misc/juce_SplashScreen.h | 2 + .../misc/juce_SystemTrayIconComponent.h | 2 + .../misc/juce_WebBrowserComponent.h | 2 + .../juce_mac_CarbonViewWrapperComponent.h | 2 + .../geometry/juce_Draggable3DOrientation.h | 2 + modules/juce_opengl/geometry/juce_Matrix3D.h | 2 + .../juce_opengl/geometry/juce_Quaternion.h | 2 + modules/juce_opengl/geometry/juce_Vector3D.h | 2 + .../native/juce_OpenGLExtensions.h | 2 + .../juce_opengl/opengl/juce_OpenGLContext.h | 2 + .../opengl/juce_OpenGLFrameBuffer.h | 2 + .../opengl/juce_OpenGLGraphicsContext.h | 2 + .../juce_opengl/opengl/juce_OpenGLHelpers.h | 2 + modules/juce_opengl/opengl/juce_OpenGLImage.h | 2 + .../opengl/juce_OpenGLPixelFormat.h | 2 + .../juce_opengl/opengl/juce_OpenGLRenderer.h | 2 + .../opengl/juce_OpenGLShaderProgram.h | 2 + .../juce_opengl/opengl/juce_OpenGLTexture.h | 2 + .../utils/juce_OpenGLAppComponent.h | 2 + modules/juce_osc/osc/juce_OSCAddress.h | 4 ++ modules/juce_osc/osc/juce_OSCArgument.h | 2 + modules/juce_osc/osc/juce_OSCBundle.h | 2 + modules/juce_osc/osc/juce_OSCMessage.h | 2 + modules/juce_osc/osc/juce_OSCReceiver.h | 2 + modules/juce_osc/osc/juce_OSCSender.h | 4 +- modules/juce_osc/osc/juce_OSCTimeTag.h | 2 + modules/juce_osc/osc/juce_OSCTypes.h | 8 +++ .../in_app_purchases/juce_InAppPurchases.h | 3 ++ .../marketplace/juce_KeyFileGeneration.h | 2 + .../marketplace/juce_OnlineUnlockForm.h | 2 + .../marketplace/juce_OnlineUnlockStatus.h | 2 + .../juce_TracktionMarketplaceStatus.h | 2 + .../juce_video/capture/juce_CameraDevice.h | 2 + .../juce_video/playback/juce_VideoComponent.h | 2 + 534 files changed, 1531 insertions(+), 72 deletions(-) diff --git a/modules/juce_analytics/analytics/juce_Analytics.h b/modules/juce_analytics/analytics/juce_Analytics.h index 4b0f21ddd7..562cbb931c 100644 --- a/modules/juce_analytics/analytics/juce_Analytics.h +++ b/modules/juce_analytics/analytics/juce_Analytics.h @@ -36,6 +36,8 @@ namespace juce @see AnalyticsDestination, ThreadedAnalyticsDestination, AnalyticsDestination::AnalyticsEvent + + @tags{Analytics} */ class JUCE_API Analytics : public DeletedAtShutdown { diff --git a/modules/juce_analytics/analytics/juce_ButtonTracker.h b/modules/juce_analytics/analytics/juce_ButtonTracker.h index 941ab1c382..89d444a771 100644 --- a/modules/juce_analytics/analytics/juce_ButtonTracker.h +++ b/modules/juce_analytics/analytics/juce_ButtonTracker.h @@ -33,6 +33,8 @@ namespace juce when a button is clicked. @see Analytics, AnalyticsDestination::AnalyticsEvent + + @tags{Analytics} */ class JUCE_API ButtonTracker : private Button::Listener { diff --git a/modules/juce_analytics/destinations/juce_AnalyticsDestination.h b/modules/juce_analytics/destinations/juce_AnalyticsDestination.h index f60a7a85fc..e1938fe45d 100644 --- a/modules/juce_analytics/destinations/juce_AnalyticsDestination.h +++ b/modules/juce_analytics/destinations/juce_AnalyticsDestination.h @@ -39,6 +39,8 @@ namespace juce with web servers and other time consuming destinations. @see Analytics, ThreadedAnalyticsDestination + + @tags{Analytics} */ struct JUCE_API AnalyticsDestination { diff --git a/modules/juce_analytics/destinations/juce_ThreadedAnalyticsDestination.h b/modules/juce_analytics/destinations/juce_ThreadedAnalyticsDestination.h index ae8bc9f43f..3eb9a4bc80 100644 --- a/modules/juce_analytics/destinations/juce_ThreadedAnalyticsDestination.h +++ b/modules/juce_analytics/destinations/juce_ThreadedAnalyticsDestination.h @@ -47,6 +47,8 @@ namespace juce you should use to terminate the currently running logBatchedEvents call. @see Analytics, AnalyticsDestination, AnalyticsDestination::AnalyticsEvent + + @tags{Analytics} */ class JUCE_API ThreadedAnalyticsDestination : public AnalyticsDestination { diff --git a/modules/juce_audio_basics/audio_play_head/juce_AudioPlayHead.h b/modules/juce_audio_basics/audio_play_head/juce_AudioPlayHead.h index 1d25049099..8a58c7ba97 100644 --- a/modules/juce_audio_basics/audio_play_head/juce_AudioPlayHead.h +++ b/modules/juce_audio_basics/audio_play_head/juce_AudioPlayHead.h @@ -32,6 +32,8 @@ namespace juce out about the position of the audio that it is rendering. @see AudioProcessor::setPlayHead, AudioProcessor::getPlayHead + + @tags{Audio} */ class JUCE_API AudioPlayHead { diff --git a/modules/juce_audio_basics/buffers/juce_AudioChannelSet.h b/modules/juce_audio_basics/buffers/juce_AudioChannelSet.h index bded8f9c07..719e029ff8 100644 --- a/modules/juce_audio_basics/buffers/juce_AudioChannelSet.h +++ b/modules/juce_audio_basics/buffers/juce_AudioChannelSet.h @@ -40,6 +40,8 @@ namespace juce as an indication to the actual layout of the speakers. @see Bus + + @tags{Audio} */ class JUCE_API AudioChannelSet { diff --git a/modules/juce_audio_basics/buffers/juce_AudioDataConverters.h b/modules/juce_audio_basics/buffers/juce_AudioDataConverters.h index 6af6822009..ddf53198d6 100644 --- a/modules/juce_audio_basics/buffers/juce_AudioDataConverters.h +++ b/modules/juce_audio_basics/buffers/juce_AudioDataConverters.h @@ -29,6 +29,8 @@ namespace juce audio sample format class. @see AudioData::Pointer. + + @tags{Audio} */ class JUCE_API AudioData { @@ -648,6 +650,8 @@ public: Note that these functions are deprecated - the AudioData class provides a much more flexible set of conversion classes now. + + @tags{Audio} */ class JUCE_API AudioDataConverters { diff --git a/modules/juce_audio_basics/buffers/juce_AudioSampleBuffer.h b/modules/juce_audio_basics/buffers/juce_AudioSampleBuffer.h index 97c13756df..8ad74ea896 100644 --- a/modules/juce_audio_basics/buffers/juce_AudioSampleBuffer.h +++ b/modules/juce_audio_basics/buffers/juce_AudioSampleBuffer.h @@ -26,6 +26,8 @@ namespace juce //============================================================================== /** A multi-channel buffer containing floating point audio samples. + + @tags{Audio} */ template class AudioBuffer diff --git a/modules/juce_audio_basics/buffers/juce_FloatVectorOperations.h b/modules/juce_audio_basics/buffers/juce_FloatVectorOperations.h index b3b97e5e40..4ad122b15f 100644 --- a/modules/juce_audio_basics/buffers/juce_FloatVectorOperations.h +++ b/modules/juce_audio_basics/buffers/juce_FloatVectorOperations.h @@ -36,6 +36,8 @@ class ScopedNoDenormals; /** A collection of simple vector operations on arrays of floats, accelerated with SIMD instructions where possible. + + @tags{Audio} */ class JUCE_API FloatVectorOperations { @@ -237,6 +239,8 @@ private: /** Helper class providing an RAII-based mechanism for temporarily disabling denormals on your CPU. + + @tags{Audio} */ class ScopedNoDenormals { diff --git a/modules/juce_audio_basics/effects/juce_CatmullRomInterpolator.h b/modules/juce_audio_basics/effects/juce_CatmullRomInterpolator.h index 5513f355b4..ab3ca754f2 100644 --- a/modules/juce_audio_basics/effects/juce_CatmullRomInterpolator.h +++ b/modules/juce_audio_basics/effects/juce_CatmullRomInterpolator.h @@ -33,6 +33,8 @@ namespace juce object. @see LagrangeInterpolator + + @tags{Audio} */ class JUCE_API CatmullRomInterpolator { diff --git a/modules/juce_audio_basics/effects/juce_Decibels.h b/modules/juce_audio_basics/effects/juce_Decibels.h index 41645972bb..f1aa5ebdd2 100644 --- a/modules/juce_audio_basics/effects/juce_Decibels.h +++ b/modules/juce_audio_basics/effects/juce_Decibels.h @@ -26,6 +26,8 @@ namespace juce //============================================================================== /** This class contains some helpful static methods for dealing with decibel values. + + @tags{Audio} */ class Decibels { diff --git a/modules/juce_audio_basics/effects/juce_IIRFilter.h b/modules/juce_audio_basics/effects/juce_IIRFilter.h index 873ba6726d..3b6e8cf593 100644 --- a/modules/juce_audio_basics/effects/juce_IIRFilter.h +++ b/modules/juce_audio_basics/effects/juce_IIRFilter.h @@ -30,6 +30,8 @@ class IIRFilter; A set of coefficients for use in an IIRFilter object. @see IIRFilter + + @tags{Audio} */ class JUCE_API IIRCoefficients { @@ -148,6 +150,8 @@ public: audio signal. @see IIRCoefficient, IIRFilterAudioSource + + @tags{Audio} */ class JUCE_API IIRFilter { diff --git a/modules/juce_audio_basics/effects/juce_LagrangeInterpolator.h b/modules/juce_audio_basics/effects/juce_LagrangeInterpolator.h index e3a152cd71..6914e465c0 100644 --- a/modules/juce_audio_basics/effects/juce_LagrangeInterpolator.h +++ b/modules/juce_audio_basics/effects/juce_LagrangeInterpolator.h @@ -33,6 +33,8 @@ namespace juce object. @see CatmullRomInterpolator + + @tags{Audio} */ class JUCE_API LagrangeInterpolator { diff --git a/modules/juce_audio_basics/effects/juce_LinearSmoothedValue.h b/modules/juce_audio_basics/effects/juce_LinearSmoothedValue.h index afb92de3d0..80dd6fc09e 100644 --- a/modules/juce_audio_basics/effects/juce_LinearSmoothedValue.h +++ b/modules/juce_audio_basics/effects/juce_LinearSmoothedValue.h @@ -27,9 +27,9 @@ namespace juce /** Utility class for linearly smoothed values like volume etc. that should not change abruptly but as a linear ramp, to avoid audio glitches. -*/ -//============================================================================== + @tags{Audio} +*/ template class LinearSmoothedValue { diff --git a/modules/juce_audio_basics/effects/juce_Reverb.h b/modules/juce_audio_basics/effects/juce_Reverb.h index 9fa37b1232..aabcad8757 100644 --- a/modules/juce_audio_basics/effects/juce_Reverb.h +++ b/modules/juce_audio_basics/effects/juce_Reverb.h @@ -32,6 +32,8 @@ namespace juce apply the reverb to your audio data. @see ReverbAudioSource + + @tags{Audio} */ class Reverb { diff --git a/modules/juce_audio_basics/midi/juce_MidiBuffer.h b/modules/juce_audio_basics/midi/juce_MidiBuffer.h index c7d534c3f6..27e86c7cc0 100644 --- a/modules/juce_audio_basics/midi/juce_MidiBuffer.h +++ b/modules/juce_audio_basics/midi/juce_MidiBuffer.h @@ -36,6 +36,8 @@ namespace juce midi data. @see MidiMessage + + @tags{Audio} */ class JUCE_API MidiBuffer { diff --git a/modules/juce_audio_basics/midi/juce_MidiFile.h b/modules/juce_audio_basics/midi/juce_MidiFile.h index a5707264d1..2226b320ef 100644 --- a/modules/juce_audio_basics/midi/juce_MidiFile.h +++ b/modules/juce_audio_basics/midi/juce_MidiFile.h @@ -35,6 +35,8 @@ namespace juce it out. @see MidiMessageSequence + + @tags{Audio} */ class JUCE_API MidiFile { diff --git a/modules/juce_audio_basics/midi/juce_MidiKeyboardState.h b/modules/juce_audio_basics/midi/juce_MidiKeyboardState.h index b3fc4e61e0..ddbbe2dba2 100644 --- a/modules/juce_audio_basics/midi/juce_MidiKeyboardState.h +++ b/modules/juce_audio_basics/midi/juce_MidiKeyboardState.h @@ -31,6 +31,8 @@ class MidiKeyboardState; Receives events from a MidiKeyboardState object. @see MidiKeyboardState + + @tags{Audio} */ class JUCE_API MidiKeyboardStateListener { @@ -78,6 +80,8 @@ public: It also allows key up/down events to be triggered with its noteOn() and noteOff() methods, and midi messages for these events will be merged into the midi stream that gets processed by processNextMidiBuffer(). + + @tags{Audio} */ class JUCE_API MidiKeyboardState { diff --git a/modules/juce_audio_basics/midi/juce_MidiMessage.h b/modules/juce_audio_basics/midi/juce_MidiMessage.h index 8327223ca7..bc7669622b 100644 --- a/modules/juce_audio_basics/midi/juce_MidiMessage.h +++ b/modules/juce_audio_basics/midi/juce_MidiMessage.h @@ -28,6 +28,8 @@ namespace juce Encapsulates a MIDI message. @see MidiMessageSequence, MidiOutput, MidiInput + + @tags{Audio} */ class JUCE_API MidiMessage { diff --git a/modules/juce_audio_basics/midi/juce_MidiMessageSequence.h b/modules/juce_audio_basics/midi/juce_MidiMessageSequence.h index 8f5e3f6994..d4f4f9265c 100644 --- a/modules/juce_audio_basics/midi/juce_MidiMessageSequence.h +++ b/modules/juce_audio_basics/midi/juce_MidiMessageSequence.h @@ -31,6 +31,8 @@ namespace juce written to a standard midi file. @see MidiMessage, MidiFile + + @tags{Audio} */ class JUCE_API MidiMessageSequence { diff --git a/modules/juce_audio_basics/midi/juce_MidiRPN.h b/modules/juce_audio_basics/midi/juce_MidiRPN.h index e8a74d1071..94ffc731e3 100644 --- a/modules/juce_audio_basics/midi/juce_MidiRPN.h +++ b/modules/juce_audio_basics/midi/juce_MidiRPN.h @@ -26,6 +26,8 @@ namespace juce //============================================================================== /** Represents a MIDI RPN (registered parameter number) or NRPN (non-registered parameter number) message. + + @tags{Audio} */ struct MidiRPNMessage { @@ -59,6 +61,8 @@ struct MidiRPNMessage LSB/MSB can be sent/received in either order and must both come before the parameter value; for the parameter value, LSB always has to be sent/received before the value MSB, otherwise it will be treated as 7-bit (MSB only). + + @tags{Audio} */ class JUCE_API MidiRPNDetector { @@ -113,6 +117,8 @@ private: or NRPN message. This sequence (as a MidiBuffer) can then be directly sent to a MidiOutput. + + @tags{Audio} */ class JUCE_API MidiRPNGenerator { diff --git a/modules/juce_audio_basics/mpe/juce_MPEInstrument.h b/modules/juce_audio_basics/mpe/juce_MPEInstrument.h index 4f24d92469..4582065df3 100644 --- a/modules/juce_audio_basics/mpe/juce_MPEInstrument.h +++ b/modules/juce_audio_basics/mpe/juce_MPEInstrument.h @@ -49,6 +49,8 @@ namespace juce the ability to render audio and to manage voices. @see MPENote, MPEZoneLayout, MPESynthesiser + + @tags{Audio} */ class JUCE_API MPEInstrument { diff --git a/modules/juce_audio_basics/mpe/juce_MPEMessages.h b/modules/juce_audio_basics/mpe/juce_MPEMessages.h index 0a3f4330c4..133ce3d87b 100644 --- a/modules/juce_audio_basics/mpe/juce_MPEMessages.h +++ b/modules/juce_audio_basics/mpe/juce_MPEMessages.h @@ -42,6 +42,8 @@ namespace juce MIDI zone layout of your C++ code and of the MPE device are kept in sync. @see MidiMessage, MPEZoneLayout + + @tags{Audio} */ class JUCE_API MPEMessages { diff --git a/modules/juce_audio_basics/mpe/juce_MPENote.h b/modules/juce_audio_basics/mpe/juce_MPENote.h index e5ef36656b..33d992b48e 100644 --- a/modules/juce_audio_basics/mpe/juce_MPENote.h +++ b/modules/juce_audio_basics/mpe/juce_MPENote.h @@ -33,6 +33,8 @@ namespace juce MPEValue objects. @see MPEValue + + @tags{Audio} */ struct JUCE_API MPENote { diff --git a/modules/juce_audio_basics/mpe/juce_MPESynthesiser.h b/modules/juce_audio_basics/mpe/juce_MPESynthesiser.h index 3ff5be75aa..d30269375f 100644 --- a/modules/juce_audio_basics/mpe/juce_MPESynthesiser.h +++ b/modules/juce_audio_basics/mpe/juce_MPESynthesiser.h @@ -48,6 +48,8 @@ namespace juce they can pitch their output correctly. @see MPESynthesiserBase, MPESynthesiserVoice, MPENote, MPEInstrument + + @tags{Audio} */ class JUCE_API MPESynthesiser : public MPESynthesiserBase { diff --git a/modules/juce_audio_basics/mpe/juce_MPESynthesiserBase.h b/modules/juce_audio_basics/mpe/juce_MPESynthesiserBase.h index 83c39a8d6f..c11c11d0f2 100644 --- a/modules/juce_audio_basics/mpe/juce_MPESynthesiserBase.h +++ b/modules/juce_audio_basics/mpe/juce_MPESynthesiserBase.h @@ -40,6 +40,8 @@ namespace juce a voice stealing algorithm, and much more. @see MPESynthesiser, MPEInstrument + + @tags{Audio} */ struct JUCE_API MPESynthesiserBase : public MPEInstrument::Listener { diff --git a/modules/juce_audio_basics/mpe/juce_MPESynthesiserVoice.h b/modules/juce_audio_basics/mpe/juce_MPESynthesiserVoice.h index 9420b051ad..f1603d5f44 100644 --- a/modules/juce_audio_basics/mpe/juce_MPESynthesiserVoice.h +++ b/modules/juce_audio_basics/mpe/juce_MPESynthesiserVoice.h @@ -31,7 +31,9 @@ namespace juce voices so that it can play polyphonically. @see MPESynthesiser, MPENote - */ + + @tags{Audio} +*/ class JUCE_API MPESynthesiserVoice { public: diff --git a/modules/juce_audio_basics/mpe/juce_MPEUtils.h b/modules/juce_audio_basics/mpe/juce_MPEUtils.h index 059ec673e6..4bb656c5df 100644 --- a/modules/juce_audio_basics/mpe/juce_MPEUtils.h +++ b/modules/juce_audio_basics/mpe/juce_MPEUtils.h @@ -31,6 +31,8 @@ namespace juce To use it, create an instance passing in the MPE zone that it should operate on and then call use the findMidiChannelForNewNote() method for all note-on messages and the noteOff() method for all note-off messages. + + @tags{Audio} */ class MPEChannelAssigner { @@ -91,6 +93,8 @@ private: /** This class handles the logic for remapping MIDI note messages from multiple MPE sources onto a specified MPE zone. + + @tags{Audio} */ class MPEChannelRemapper { diff --git a/modules/juce_audio_basics/mpe/juce_MPEValue.h b/modules/juce_audio_basics/mpe/juce_MPEValue.h index b1ea512daa..242d9c5c79 100644 --- a/modules/juce_audio_basics/mpe/juce_MPEValue.h +++ b/modules/juce_audio_basics/mpe/juce_MPEValue.h @@ -30,6 +30,8 @@ namespace juce (corresponding to 1 or 2 MIDI bytes, respectively). It also offers helper functions to query the value in a variety of representations that can be useful in an audio or MIDI context. + + @tags{Audio} */ class JUCE_API MPEValue { diff --git a/modules/juce_audio_basics/mpe/juce_MPEZoneLayout.h b/modules/juce_audio_basics/mpe/juce_MPEZoneLayout.h index c3da69cb7b..1414324ce3 100644 --- a/modules/juce_audio_basics/mpe/juce_MPEZoneLayout.h +++ b/modules/juce_audio_basics/mpe/juce_MPEZoneLayout.h @@ -38,6 +38,8 @@ namespace juce MIDI device to set its zone layout, add zones etc. @see MPEInstrument + + @tags{Audio} */ class JUCE_API MPEZoneLayout { diff --git a/modules/juce_audio_basics/native/juce_mac_CoreAudioLayouts.h b/modules/juce_audio_basics/native/juce_mac_CoreAudioLayouts.h index 647bc328f2..8fa387a638 100644 --- a/modules/juce_audio_basics/native/juce_mac_CoreAudioLayouts.h +++ b/modules/juce_audio_basics/native/juce_mac_CoreAudioLayouts.h @@ -23,7 +23,7 @@ namespace juce { -#if JUCE_MAC || JUCE_IOS +#if JUCE_MAC || JUCE_IOS && ! DOXYGEN struct CoreAudioLayouts { diff --git a/modules/juce_audio_basics/sources/juce_AudioSource.h b/modules/juce_audio_basics/sources/juce_AudioSource.h index f8478ba604..9633f67b83 100644 --- a/modules/juce_audio_basics/sources/juce_AudioSource.h +++ b/modules/juce_audio_basics/sources/juce_AudioSource.h @@ -26,6 +26,8 @@ namespace juce //============================================================================== /** Used by AudioSource::getNextAudioBlock(). + + @tags{Audio} */ struct JUCE_API AudioSourceChannelInfo { @@ -103,6 +105,8 @@ struct JUCE_API AudioSourceChannelInfo back into an 'unprepared' state. @see AudioFormatReaderSource, ResamplingAudioSource + + @tags{Audio} */ class JUCE_API AudioSource { diff --git a/modules/juce_audio_basics/sources/juce_BufferingAudioSource.h b/modules/juce_audio_basics/sources/juce_BufferingAudioSource.h index 2c70e00821..bf272969fd 100644 --- a/modules/juce_audio_basics/sources/juce_BufferingAudioSource.h +++ b/modules/juce_audio_basics/sources/juce_BufferingAudioSource.h @@ -32,6 +32,8 @@ namespace juce directly, or use it indirectly using an AudioTransportSource. @see PositionableAudioSource, AudioTransportSource + + @tags{Audio} */ class JUCE_API BufferingAudioSource : public PositionableAudioSource, private TimeSliceClient diff --git a/modules/juce_audio_basics/sources/juce_ChannelRemappingAudioSource.h b/modules/juce_audio_basics/sources/juce_ChannelRemappingAudioSource.h index da73ae5c46..f46093b2f1 100644 --- a/modules/juce_audio_basics/sources/juce_ChannelRemappingAudioSource.h +++ b/modules/juce_audio_basics/sources/juce_ChannelRemappingAudioSource.h @@ -37,6 +37,8 @@ namespace juce it'll produce silence. @see AudioSource + + @tags{Audio} */ class ChannelRemappingAudioSource : public AudioSource { diff --git a/modules/juce_audio_basics/sources/juce_IIRFilterAudioSource.h b/modules/juce_audio_basics/sources/juce_IIRFilterAudioSource.h index 38faf285bc..35030c069c 100644 --- a/modules/juce_audio_basics/sources/juce_IIRFilterAudioSource.h +++ b/modules/juce_audio_basics/sources/juce_IIRFilterAudioSource.h @@ -26,6 +26,8 @@ namespace juce //============================================================================== /** An AudioSource that performs an IIR filter on another source. + + @tags{Audio} */ class JUCE_API IIRFilterAudioSource : public AudioSource { diff --git a/modules/juce_audio_basics/sources/juce_MemoryAudioSource.h b/modules/juce_audio_basics/sources/juce_MemoryAudioSource.h index 50b11c7b93..d46bd4f4a8 100644 --- a/modules/juce_audio_basics/sources/juce_MemoryAudioSource.h +++ b/modules/juce_audio_basics/sources/juce_MemoryAudioSource.h @@ -26,6 +26,8 @@ namespace juce //============================================================================== /** An AudioSource which takes some float audio data as an input. + + @tags{Audio} */ class JUCE_API MemoryAudioSource : public AudioSource { diff --git a/modules/juce_audio_basics/sources/juce_MixerAudioSource.h b/modules/juce_audio_basics/sources/juce_MixerAudioSource.h index 820f0b2229..8b3e9c27e5 100644 --- a/modules/juce_audio_basics/sources/juce_MixerAudioSource.h +++ b/modules/juce_audio_basics/sources/juce_MixerAudioSource.h @@ -30,6 +30,8 @@ namespace juce Input sources can be added and removed while the mixer is running as long as their prepareToPlay() and releaseResources() methods are called before and after adding them to the mixer. + + @tags{Audio} */ class JUCE_API MixerAudioSource : public AudioSource { diff --git a/modules/juce_audio_basics/sources/juce_PositionableAudioSource.h b/modules/juce_audio_basics/sources/juce_PositionableAudioSource.h index 5908bb82bd..610d2c5af4 100644 --- a/modules/juce_audio_basics/sources/juce_PositionableAudioSource.h +++ b/modules/juce_audio_basics/sources/juce_PositionableAudioSource.h @@ -32,6 +32,8 @@ namespace juce that has a current read position. @see AudioSource, AudioTransportSource + + @tags{Audio} */ class JUCE_API PositionableAudioSource : public AudioSource { diff --git a/modules/juce_audio_basics/sources/juce_ResamplingAudioSource.h b/modules/juce_audio_basics/sources/juce_ResamplingAudioSource.h index 10cd357aa4..0ff3fae6b3 100644 --- a/modules/juce_audio_basics/sources/juce_ResamplingAudioSource.h +++ b/modules/juce_audio_basics/sources/juce_ResamplingAudioSource.h @@ -28,6 +28,8 @@ namespace juce A type of AudioSource that takes an input source and changes its sample rate. @see AudioSource, LagrangeInterpolator, CatmullRomInterpolator + + @tags{Audio} */ class JUCE_API ResamplingAudioSource : public AudioSource { diff --git a/modules/juce_audio_basics/sources/juce_ReverbAudioSource.h b/modules/juce_audio_basics/sources/juce_ReverbAudioSource.h index 1d2591b649..ddddb546e0 100644 --- a/modules/juce_audio_basics/sources/juce_ReverbAudioSource.h +++ b/modules/juce_audio_basics/sources/juce_ReverbAudioSource.h @@ -28,6 +28,8 @@ namespace juce An AudioSource that uses the Reverb class to apply a reverb to another AudioSource. @see Reverb + + @tags{Audio} */ class JUCE_API ReverbAudioSource : public AudioSource { diff --git a/modules/juce_audio_basics/sources/juce_ToneGeneratorAudioSource.h b/modules/juce_audio_basics/sources/juce_ToneGeneratorAudioSource.h index 9c8e939d94..ea1da6afa8 100644 --- a/modules/juce_audio_basics/sources/juce_ToneGeneratorAudioSource.h +++ b/modules/juce_audio_basics/sources/juce_ToneGeneratorAudioSource.h @@ -27,6 +27,8 @@ namespace juce /** A simple AudioSource that generates a sine wave. + + @tags{Audio} */ class JUCE_API ToneGeneratorAudioSource : public AudioSource { diff --git a/modules/juce_audio_basics/synthesisers/juce_Synthesiser.h b/modules/juce_audio_basics/synthesisers/juce_Synthesiser.h index 5183d17d83..c056896e74 100644 --- a/modules/juce_audio_basics/synthesisers/juce_Synthesiser.h +++ b/modules/juce_audio_basics/synthesisers/juce_Synthesiser.h @@ -35,6 +35,8 @@ namespace juce more than one SynthesiserVoice to play the same sound at the same time. @see Synthesiser, SynthesiserVoice + + @tags{Audio} */ class JUCE_API SynthesiserSound : public ReferenceCountedObject { @@ -79,6 +81,8 @@ private: voices so that it can play polyphonically. @see Synthesiser, SynthesiserSound + + @tags{Audio} */ class JUCE_API SynthesiserVoice { @@ -302,6 +306,8 @@ private: Before rendering, be sure to call the setCurrentPlaybackSampleRate() to tell it what the target playback rate is. This value is passed on to the voices so that they can pitch their output correctly. + + @tags{Audio} */ class JUCE_API Synthesiser { diff --git a/modules/juce_audio_devices/audio_io/juce_AudioDeviceManager.h b/modules/juce_audio_devices/audio_io/juce_AudioDeviceManager.h index e9da12ef56..ca735e7d0f 100644 --- a/modules/juce_audio_devices/audio_io/juce_AudioDeviceManager.h +++ b/modules/juce_audio_devices/audio_io/juce_AudioDeviceManager.h @@ -60,6 +60,8 @@ namespace juce listeners whenever one of its settings is changed. @see AudioDeviceSelectorComponent, AudioIODevice, AudioIODeviceType + + @tags{Audio} */ class JUCE_API AudioDeviceManager : public ChangeBroadcaster { diff --git a/modules/juce_audio_devices/audio_io/juce_AudioIODevice.h b/modules/juce_audio_devices/audio_io/juce_AudioIODevice.h index 33c3cfdb32..8367984235 100644 --- a/modules/juce_audio_devices/audio_io/juce_AudioIODevice.h +++ b/modules/juce_audio_devices/audio_io/juce_AudioIODevice.h @@ -36,6 +36,8 @@ class AudioIODevice; the next block of data. @see AudioIODevice, AudioDeviceManager + + @tags{Audio} */ class JUCE_API AudioIODeviceCallback { @@ -128,6 +130,8 @@ public: AudioDeviceManager class. @see AudioIODeviceType, AudioDeviceManager + + @tags{Audio} */ class JUCE_API AudioIODevice { diff --git a/modules/juce_audio_devices/audio_io/juce_AudioIODeviceType.h b/modules/juce_audio_devices/audio_io/juce_AudioIODeviceType.h index 74c420acde..a3d2d73ac1 100644 --- a/modules/juce_audio_devices/audio_io/juce_AudioIODeviceType.h +++ b/modules/juce_audio_devices/audio_io/juce_AudioIODeviceType.h @@ -55,6 +55,8 @@ namespace juce AudioDeviceManager class. @see AudioIODevice, AudioDeviceManager + + @tags{Audio} */ class JUCE_API AudioIODeviceType { diff --git a/modules/juce_audio_devices/audio_io/juce_SystemAudioVolume.h b/modules/juce_audio_devices/audio_io/juce_SystemAudioVolume.h index bf5c44c6af..a29537c5b7 100644 --- a/modules/juce_audio_devices/audio_io/juce_SystemAudioVolume.h +++ b/modules/juce_audio_devices/audio_io/juce_SystemAudioVolume.h @@ -26,6 +26,8 @@ namespace juce //============================================================================== /** Contains functions to control the system's master volume. + + @tags{Audio} */ class JUCE_API SystemAudioVolume { diff --git a/modules/juce_audio_devices/midi_io/juce_MidiInput.h b/modules/juce_audio_devices/midi_io/juce_MidiInput.h index 52edd9fe09..e0260b621b 100644 --- a/modules/juce_audio_devices/midi_io/juce_MidiInput.h +++ b/modules/juce_audio_devices/midi_io/juce_MidiInput.h @@ -34,6 +34,8 @@ class MidiInput; class for more details. @see MidiInput + + @tags{Audio} */ class JUCE_API MidiInputCallback { @@ -84,6 +86,8 @@ public: available, and then use the openDevice() method to try to open one. @see MidiOutput + + @tags{Audio} */ class JUCE_API MidiInput { diff --git a/modules/juce_audio_devices/midi_io/juce_MidiMessageCollector.h b/modules/juce_audio_devices/midi_io/juce_MidiMessageCollector.h index aa8bcdbeb6..346e118759 100644 --- a/modules/juce_audio_devices/midi_io/juce_MidiMessageCollector.h +++ b/modules/juce_audio_devices/midi_io/juce_MidiMessageCollector.h @@ -32,6 +32,8 @@ namespace juce so it can easily use a midi input or keyboard component as its source. @see MidiMessage, MidiInput + + @tags{Audio} */ class JUCE_API MidiMessageCollector : public MidiKeyboardStateListener, public MidiInputCallback diff --git a/modules/juce_audio_devices/midi_io/juce_MidiOutput.h b/modules/juce_audio_devices/midi_io/juce_MidiOutput.h index f05dc32f14..3a102990b1 100644 --- a/modules/juce_audio_devices/midi_io/juce_MidiOutput.h +++ b/modules/juce_audio_devices/midi_io/juce_MidiOutput.h @@ -31,6 +31,8 @@ namespace juce available output devices, then use the openDevice() method to try to open one. @see MidiInput + + @tags{Audio} */ class JUCE_API MidiOutput : private Thread { diff --git a/modules/juce_audio_devices/native/juce_MidiDataConcatenator.h b/modules/juce_audio_devices/native/juce_MidiDataConcatenator.h index 1df491240a..fa8080fa42 100644 --- a/modules/juce_audio_devices/native/juce_MidiDataConcatenator.h +++ b/modules/juce_audio_devices/native/juce_MidiDataConcatenator.h @@ -27,6 +27,8 @@ namespace juce /** Helper class that takes chunks of incoming midi bytes, packages them into messages, and dispatches them to a midi callback. + + @tags{Audio} */ class MidiDataConcatenator { diff --git a/modules/juce_audio_devices/sources/juce_AudioSourcePlayer.h b/modules/juce_audio_devices/sources/juce_AudioSourcePlayer.h index 4637be4f3f..295447f97d 100644 --- a/modules/juce_audio_devices/sources/juce_AudioSourcePlayer.h +++ b/modules/juce_audio_devices/sources/juce_AudioSourcePlayer.h @@ -30,6 +30,8 @@ namespace juce This object acts as an AudioIODeviceCallback, so can be attached to an output device, and will stream audio from an AudioSource. + + @tags{Audio} */ class JUCE_API AudioSourcePlayer : public AudioIODeviceCallback { diff --git a/modules/juce_audio_devices/sources/juce_AudioTransportSource.h b/modules/juce_audio_devices/sources/juce_AudioTransportSource.h index b133691326..1dde682810 100644 --- a/modules/juce_audio_devices/sources/juce_AudioTransportSource.h +++ b/modules/juce_audio_devices/sources/juce_AudioTransportSource.h @@ -35,6 +35,8 @@ namespace juce to control playback of an audio file. @see AudioSource, AudioSourcePlayer + + @tags{Audio} */ class JUCE_API AudioTransportSource : public PositionableAudioSource, public ChangeBroadcaster diff --git a/modules/juce_audio_formats/codecs/juce_AiffAudioFormat.h b/modules/juce_audio_formats/codecs/juce_AiffAudioFormat.h index cd4c5f43a6..df37df89f6 100644 --- a/modules/juce_audio_formats/codecs/juce_AiffAudioFormat.h +++ b/modules/juce_audio_formats/codecs/juce_AiffAudioFormat.h @@ -32,6 +32,8 @@ namespace juce Reads and Writes AIFF format audio files. @see AudioFormat + + @tags{Audio} */ class JUCE_API AiffAudioFormat : public AudioFormat { diff --git a/modules/juce_audio_formats/codecs/juce_CoreAudioFormat.h b/modules/juce_audio_formats/codecs/juce_CoreAudioFormat.h index 878d84e0f6..b0a286039f 100644 --- a/modules/juce_audio_formats/codecs/juce_CoreAudioFormat.h +++ b/modules/juce_audio_formats/codecs/juce_CoreAudioFormat.h @@ -37,7 +37,9 @@ namespace juce This should be able to understand formats such as mp3, m4a, etc. @see AudioFormat - */ + + @tags{Audio} +*/ class JUCE_API CoreAudioFormat : public AudioFormat { public: diff --git a/modules/juce_audio_formats/codecs/juce_FlacAudioFormat.h b/modules/juce_audio_formats/codecs/juce_FlacAudioFormat.h index fe61e3c59e..4cbca69cb4 100644 --- a/modules/juce_audio_formats/codecs/juce_FlacAudioFormat.h +++ b/modules/juce_audio_formats/codecs/juce_FlacAudioFormat.h @@ -36,6 +36,8 @@ namespace juce To compile this, you'll need to set the JUCE_USE_FLAC flag. @see AudioFormat + + @tags{Audio} */ class JUCE_API FlacAudioFormat : public AudioFormat { diff --git a/modules/juce_audio_formats/codecs/juce_LAMEEncoderAudioFormat.h b/modules/juce_audio_formats/codecs/juce_LAMEEncoderAudioFormat.h index 45b578842d..4260570c21 100644 --- a/modules/juce_audio_formats/codecs/juce_LAMEEncoderAudioFormat.h +++ b/modules/juce_audio_formats/codecs/juce_LAMEEncoderAudioFormat.h @@ -42,6 +42,8 @@ namespace juce the writer. @see AudioFormat + + @tags{Audio} */ class JUCE_API LAMEEncoderAudioFormat : public AudioFormat { diff --git a/modules/juce_audio_formats/codecs/juce_MP3AudioFormat.h b/modules/juce_audio_formats/codecs/juce_MP3AudioFormat.h index cde3298ec7..b064665572 100644 --- a/modules/juce_audio_formats/codecs/juce_MP3AudioFormat.h +++ b/modules/juce_audio_formats/codecs/juce_MP3AudioFormat.h @@ -42,6 +42,8 @@ namespace juce intellectual property. If you wish to use it, please seek your own independent advice about the legality of doing so. If you are not willing to accept full responsibility for the consequences of using this code, then do not enable the JUCE_USE_MP3AUDIOFORMAT setting. + + @tags{Audio} */ class MP3AudioFormat : public AudioFormat { diff --git a/modules/juce_audio_formats/codecs/juce_OggVorbisAudioFormat.h b/modules/juce_audio_formats/codecs/juce_OggVorbisAudioFormat.h index c8f4704e54..ffb4a815e4 100644 --- a/modules/juce_audio_formats/codecs/juce_OggVorbisAudioFormat.h +++ b/modules/juce_audio_formats/codecs/juce_OggVorbisAudioFormat.h @@ -36,6 +36,8 @@ namespace juce To compile this, you'll need to set the JUCE_USE_OGGVORBIS flag. @see AudioFormat, + + @tags{Audio} */ class JUCE_API OggVorbisAudioFormat : public AudioFormat { diff --git a/modules/juce_audio_formats/codecs/juce_WavAudioFormat.h b/modules/juce_audio_formats/codecs/juce_WavAudioFormat.h index 85580208f3..2273e8d7e7 100644 --- a/modules/juce_audio_formats/codecs/juce_WavAudioFormat.h +++ b/modules/juce_audio_formats/codecs/juce_WavAudioFormat.h @@ -32,6 +32,8 @@ namespace juce Reads and Writes WAV format audio files. @see AudioFormat + + @tags{Audio} */ class JUCE_API WavAudioFormat : public AudioFormat { diff --git a/modules/juce_audio_formats/codecs/juce_WindowsMediaAudioFormat.h b/modules/juce_audio_formats/codecs/juce_WindowsMediaAudioFormat.h index 97c746e299..1b600c5471 100644 --- a/modules/juce_audio_formats/codecs/juce_WindowsMediaAudioFormat.h +++ b/modules/juce_audio_formats/codecs/juce_WindowsMediaAudioFormat.h @@ -32,6 +32,8 @@ namespace juce //============================================================================== /** Audio format which uses the Windows Media codecs (Windows only). + + @tags{Audio} */ class WindowsMediaAudioFormat : public AudioFormat { diff --git a/modules/juce_audio_formats/format/juce_AudioFormat.h b/modules/juce_audio_formats/format/juce_AudioFormat.h index 103ddd6308..dd6bacca97 100644 --- a/modules/juce_audio_formats/format/juce_AudioFormat.h +++ b/modules/juce_audio_formats/format/juce_AudioFormat.h @@ -33,6 +33,8 @@ namespace juce file formats. @see AudioFormatReader, AudioFormatWriter, WavAudioFormat, AiffAudioFormat + + @tags{Audio} */ class JUCE_API AudioFormat { diff --git a/modules/juce_audio_formats/format/juce_AudioFormatManager.h b/modules/juce_audio_formats/format/juce_AudioFormatManager.h index 70d30afc6f..1a618aaaee 100644 --- a/modules/juce_audio_formats/format/juce_AudioFormatManager.h +++ b/modules/juce_audio_formats/format/juce_AudioFormatManager.h @@ -36,6 +36,8 @@ namespace juce or registerBasicFormats() to give it a list of format types that it can use. @see AudioFormat + + @tags{Audio} */ class JUCE_API AudioFormatManager { diff --git a/modules/juce_audio_formats/format/juce_AudioFormatReader.h b/modules/juce_audio_formats/format/juce_AudioFormatReader.h index 0351b06eac..d9342dfb03 100644 --- a/modules/juce_audio_formats/format/juce_AudioFormatReader.h +++ b/modules/juce_audio_formats/format/juce_AudioFormatReader.h @@ -38,6 +38,8 @@ class AudioFormat; an AudioFormat object. @see AudioFormat, AudioFormatWriter + + @tags{Audio} */ class JUCE_API AudioFormatReader { diff --git a/modules/juce_audio_formats/format/juce_AudioFormatReaderSource.h b/modules/juce_audio_formats/format/juce_AudioFormatReaderSource.h index 3ad72c3601..f09606632c 100644 --- a/modules/juce_audio_formats/format/juce_AudioFormatReaderSource.h +++ b/modules/juce_audio_formats/format/juce_AudioFormatReaderSource.h @@ -32,6 +32,8 @@ namespace juce A type of AudioSource that will read from an AudioFormatReader. @see PositionableAudioSource, AudioTransportSource, BufferingAudioSource + + @tags{Audio} */ class JUCE_API AudioFormatReaderSource : public PositionableAudioSource { diff --git a/modules/juce_audio_formats/format/juce_AudioFormatWriter.h b/modules/juce_audio_formats/format/juce_AudioFormatWriter.h index 434484bd1d..6c97a14f1e 100644 --- a/modules/juce_audio_formats/format/juce_AudioFormatWriter.h +++ b/modules/juce_audio_formats/format/juce_AudioFormatWriter.h @@ -38,6 +38,8 @@ namespace juce you can call its write() method to store the samples, and then delete it. @see AudioFormat, AudioFormatReader + + @tags{Audio} */ class JUCE_API AudioFormatWriter { @@ -210,6 +212,7 @@ public: */ bool write (const float* const* data, int numSamples); + /** Receiver for incoming data. */ class JUCE_API IncomingDataReceiver { public: @@ -223,8 +226,8 @@ public: /** Allows you to specify a callback that this writer should update with the incoming data. - The receiver will be cleared and will the writer will begin adding data to - it as the data arrives. Pass a null pointer to remove the current receiver. + The receiver will be cleared and the writer will begin adding data to it + as the data arrives. Pass a null pointer to remove the current receiver. The object passed-in must not be deleted while this writer is still using it. */ diff --git a/modules/juce_audio_formats/format/juce_AudioSubsectionReader.h b/modules/juce_audio_formats/format/juce_AudioSubsectionReader.h index 523fb59cbf..71ade5f6c9 100644 --- a/modules/juce_audio_formats/format/juce_AudioSubsectionReader.h +++ b/modules/juce_audio_formats/format/juce_AudioSubsectionReader.h @@ -39,6 +39,8 @@ namespace juce be at a non-zero position. @see AudioFormatReader + + @tags{Audio} */ class JUCE_API AudioSubsectionReader : public AudioFormatReader { diff --git a/modules/juce_audio_formats/format/juce_BufferingAudioFormatReader.h b/modules/juce_audio_formats/format/juce_BufferingAudioFormatReader.h index b16c3a757d..25e726655f 100644 --- a/modules/juce_audio_formats/format/juce_BufferingAudioFormatReader.h +++ b/modules/juce_audio_formats/format/juce_BufferingAudioFormatReader.h @@ -33,6 +33,8 @@ namespace juce another reader. @see AudioFormatReader + + @tags{Audio} */ class JUCE_API BufferingAudioReader : public AudioFormatReader, private TimeSliceClient diff --git a/modules/juce_audio_formats/format/juce_MemoryMappedAudioFormatReader.h b/modules/juce_audio_formats/format/juce_MemoryMappedAudioFormatReader.h index 4b9454c953..62ad3daaeb 100644 --- a/modules/juce_audio_formats/format/juce_MemoryMappedAudioFormatReader.h +++ b/modules/juce_audio_formats/format/juce_MemoryMappedAudioFormatReader.h @@ -41,6 +41,8 @@ namespace juce read has been mapped. @see AudioFormat::createMemoryMappedReader, AudioFormatReader + + @tags{Audio} */ class JUCE_API MemoryMappedAudioFormatReader : public AudioFormatReader { diff --git a/modules/juce_audio_formats/sampler/juce_Sampler.h b/modules/juce_audio_formats/sampler/juce_Sampler.h index 61bd2eae58..f3f88c7627 100644 --- a/modules/juce_audio_formats/sampler/juce_Sampler.h +++ b/modules/juce_audio_formats/sampler/juce_Sampler.h @@ -38,6 +38,8 @@ namespace juce give it some SampledSound objects to play. @see SamplerVoice, Synthesiser, SynthesiserSound + + @tags{Audio} */ class JUCE_API SamplerSound : public SynthesiserSound { @@ -110,6 +112,8 @@ private: give it some SampledSound objects to play. @see SamplerSound, Synthesiser, SynthesiserVoice + + @tags{Audio} */ class JUCE_API SamplerVoice : public SynthesiserVoice { diff --git a/modules/juce_audio_plugin_client/AAX/juce_AAX_Modifier_Injector.h b/modules/juce_audio_plugin_client/AAX/juce_AAX_Modifier_Injector.h index bc73e38117..eff644638d 100644 --- a/modules/juce_audio_plugin_client/AAX/juce_AAX_Modifier_Injector.h +++ b/modules/juce_audio_plugin_client/AAX/juce_AAX_Modifier_Injector.h @@ -27,6 +27,8 @@ namespace juce { +#ifndef DOXYGEN + struct ModifierKeyProvider { virtual ~ModifierKeyProvider() {} @@ -40,4 +42,6 @@ struct ModifierKeyReceiver virtual void removeModifierKeyProvider() = 0; }; +#endif + } // namespace juce diff --git a/modules/juce_audio_plugin_client/Standalone/juce_StandaloneFilterWindow.h b/modules/juce_audio_plugin_client/Standalone/juce_StandaloneFilterWindow.h index ddd5076ad8..69bd2cdea4 100644 --- a/modules/juce_audio_plugin_client/Standalone/juce_StandaloneFilterWindow.h +++ b/modules/juce_audio_plugin_client/Standalone/juce_StandaloneFilterWindow.h @@ -38,12 +38,15 @@ namespace juce The object will create your processor using the same createPluginFilter() function that the other plugin wrappers use, and will run it through the computer's audio/MIDI devices using AudioDeviceManager and AudioProcessorPlayer. + + @tags{Audio} */ class StandalonePluginHolder : private AudioIODeviceCallback, private Timer { public: //============================================================================== + /** Structure used for the number of inputs and outputs. */ struct PluginInOuts { short numIns, numOuts; }; //============================================================================== @@ -558,6 +561,8 @@ private: Just create one of these objects in your JUCEApplicationBase::initialise() method, and let it do its work. It will create your filter object using the same createPluginFilter() function that the other plugin wrappers use. + + @tags{Audio} */ class StandaloneFilterWindow : public DocumentWindow, public Button::Listener diff --git a/modules/juce_audio_plugin_client/VST/juce_VSTCallbackHandler.h b/modules/juce_audio_plugin_client/VST/juce_VSTCallbackHandler.h index 4a00dd3e20..2e959c667c 100644 --- a/modules/juce_audio_plugin_client/VST/juce_VSTCallbackHandler.h +++ b/modules/juce_audio_plugin_client/VST/juce_VSTCallbackHandler.h @@ -29,6 +29,8 @@ namespace juce /** An interface to allow an AudioProcessor to receive VST specific calls from the host. + + @tags{Audio} */ struct VSTCallbackHandler { diff --git a/modules/juce_audio_plugin_client/utility/juce_FakeMouseMoveGenerator.h b/modules/juce_audio_plugin_client/utility/juce_FakeMouseMoveGenerator.h index 299ca4ceb3..f2620756be 100644 --- a/modules/juce_audio_plugin_client/utility/juce_FakeMouseMoveGenerator.h +++ b/modules/juce_audio_plugin_client/utility/juce_FakeMouseMoveGenerator.h @@ -27,6 +27,8 @@ namespace juce { +#ifndef DOXYGEN + #if JUCE_MAC //============================================================================== @@ -90,4 +92,6 @@ private: struct FakeMouseMoveGenerator {}; #endif +#endif + } // namespace juce diff --git a/modules/juce_audio_plugin_client/utility/juce_PluginHostType.h b/modules/juce_audio_plugin_client/utility/juce_PluginHostType.h index 090a7e3a9c..c020008ea9 100644 --- a/modules/juce_audio_plugin_client/utility/juce_PluginHostType.h +++ b/modules/juce_audio_plugin_client/utility/juce_PluginHostType.h @@ -33,6 +33,8 @@ namespace juce loaded. Declare a PluginHostType object in your class to use it. + + @tags{Audio} */ class PluginHostType { diff --git a/modules/juce_audio_processors/format/juce_AudioPluginFormat.h b/modules/juce_audio_processors/format/juce_AudioPluginFormat.h index 6eb08eb324..be7a257637 100644 --- a/modules/juce_audio_processors/format/juce_AudioPluginFormat.h +++ b/modules/juce_audio_processors/format/juce_AudioPluginFormat.h @@ -32,11 +32,14 @@ namespace juce The base class for a type of plugin format, such as VST, AudioUnit, LADSPA, etc. @see AudioPluginFormatManager + + @tags{Audio} */ class JUCE_API AudioPluginFormat { public: //============================================================================== + /** Structure used for callbacks when instantiation is completed. */ struct JUCE_API InstantiationCompletionCallback { virtual ~InstantiationCompletionCallback() {} diff --git a/modules/juce_audio_processors/format/juce_AudioPluginFormatManager.h b/modules/juce_audio_processors/format/juce_AudioPluginFormatManager.h index 495c222919..54b67b79d9 100644 --- a/modules/juce_audio_processors/format/juce_AudioPluginFormatManager.h +++ b/modules/juce_audio_processors/format/juce_AudioPluginFormatManager.h @@ -32,6 +32,8 @@ namespace juce This maintains a list of known AudioPluginFormats. @see AudioPluginFormat + + @tags{Audio} */ class JUCE_API AudioPluginFormatManager { diff --git a/modules/juce_audio_processors/format_types/juce_AU_Shared.h b/modules/juce_audio_processors/format_types/juce_AU_Shared.h index 22b2ad938d..8da0a9d52e 100644 --- a/modules/juce_audio_processors/format_types/juce_AU_Shared.h +++ b/modules/juce_audio_processors/format_types/juce_AU_Shared.h @@ -32,6 +32,8 @@ namespace juce { +#ifndef DOXYGEN + struct AudioUnitHelpers { class ChannelRemapper @@ -530,4 +532,6 @@ struct AudioUnitHelpers } }; +#endif // ! DOXYGEN + } // namespace juce diff --git a/modules/juce_audio_processors/format_types/juce_AudioUnitPluginFormat.h b/modules/juce_audio_processors/format_types/juce_AudioUnitPluginFormat.h index a4d0e1b169..5810e80f08 100644 --- a/modules/juce_audio_processors/format_types/juce_AudioUnitPluginFormat.h +++ b/modules/juce_audio_processors/format_types/juce_AudioUnitPluginFormat.h @@ -32,6 +32,8 @@ namespace juce //============================================================================== /** Implements a plugin format manager for AudioUnits. + + @tags{Audio} */ class JUCE_API AudioUnitPluginFormat : public AudioPluginFormat { diff --git a/modules/juce_audio_processors/format_types/juce_LADSPAPluginFormat.h b/modules/juce_audio_processors/format_types/juce_LADSPAPluginFormat.h index 7002c51814..dbe205a7a7 100644 --- a/modules/juce_audio_processors/format_types/juce_LADSPAPluginFormat.h +++ b/modules/juce_audio_processors/format_types/juce_LADSPAPluginFormat.h @@ -32,6 +32,8 @@ namespace juce //============================================================================== /** Implements a plugin format manager for LADSPA plugins. + + @tags{Audio} */ class JUCE_API LADSPAPluginFormat : public AudioPluginFormat { diff --git a/modules/juce_audio_processors/format_types/juce_VST3PluginFormat.h b/modules/juce_audio_processors/format_types/juce_VST3PluginFormat.h index dfdfdc0e2f..c4f77b6389 100644 --- a/modules/juce_audio_processors/format_types/juce_VST3PluginFormat.h +++ b/modules/juce_audio_processors/format_types/juce_VST3PluginFormat.h @@ -31,6 +31,8 @@ namespace juce /** Implements a plugin format for VST3s. + + @tags{Audio} */ class JUCE_API VST3PluginFormat : public AudioPluginFormat { diff --git a/modules/juce_audio_processors/format_types/juce_VSTCommon.h b/modules/juce_audio_processors/format_types/juce_VSTCommon.h index 7a0aa5841f..4b40443bda 100644 --- a/modules/juce_audio_processors/format_types/juce_VSTCommon.h +++ b/modules/juce_audio_processors/format_types/juce_VSTCommon.h @@ -28,8 +28,13 @@ namespace juce { //============================================================================== +/** Structure for VST speaker mappings + + @tags{Audio} +*/ struct SpeakerMappings : private AudioChannelSet // (inheritance only to give easier access to items in the namespace) { + /** Structure describing a mapping */ struct Mapping { int32 vst2; @@ -125,6 +130,7 @@ struct SpeakerMappings : private AudioChannelSet // (inheritance only to give e return vstSpeakerConfigTypeUser; } + /** Class to hold a speaker configuration */ class VstSpeakerConfigurationHolder { public: diff --git a/modules/juce_audio_processors/format_types/juce_VSTInterface.h b/modules/juce_audio_processors/format_types/juce_VSTInterface.h index 4d31c312a0..a2f09aae93 100644 --- a/modules/juce_audio_processors/format_types/juce_VSTInterface.h +++ b/modules/juce_audio_processors/format_types/juce_VSTInterface.h @@ -48,6 +48,10 @@ const int32 juceVstInterfaceVersion = 2400; const int32 juceVstInterfaceIdentifier = 0x56737450; // The "magic" identifier in the SDK is 'VstP'. //============================================================================== +/** Structure used for VSTs + + @tags{Audio} +*/ struct VstEffectInterface { int32 interfaceIdentifier; @@ -221,6 +225,10 @@ enum VstPlugInCategory }; //============================================================================== +/** Structure used for VSTs + + @tags{Audio} +*/ struct VstEditorBounds { int16 upper; @@ -241,6 +249,10 @@ enum VstMaxStringLengths }; //============================================================================== +/** Structure used for VSTs + + @tags{Audio} +*/ struct VstPinInfo { char text[vstMaxParameterOrPinLabelLength]; @@ -258,6 +270,10 @@ enum VstPinInfoFlags }; //============================================================================== +/** Structure used for VSTs + + @tags{Audio} +*/ struct VstEvent { int32 type; @@ -273,6 +289,10 @@ enum VstEventTypes vstSysExEventType = 6 }; +/** Structure used for VSTs + + @tags{Audio} +*/ struct VstEventBlock { int32 numberOfEvents; @@ -280,6 +300,10 @@ struct VstEventBlock VstEvent* events[2]; }; +/** Structure used for VSTs + + @tags{Audio} +*/ struct VstMidiEvent { int32 type; @@ -300,6 +324,10 @@ enum VstMidiEventFlags vstMidiEventIsRealtime = 1 }; +/** Structure used for VSTs + + @tags{Audio} +*/ struct VstSysExEvent { int32 type; @@ -313,6 +341,10 @@ struct VstSysExEvent }; //============================================================================== +/** Structure used for VSTs + + @tags{Audio} +*/ struct VstTimingInformation { double samplePosition; @@ -369,6 +401,10 @@ enum VstSmpteRates }; //============================================================================== +/** Structure used for VSTs + + @tags{Audio} +*/ struct VstIndividualSpeakerInfo { float azimuthalAngle; @@ -406,6 +442,10 @@ enum VstIndividualSpeakerType vstIndividualSpeakerTypeLFE2 }; +/** Structure used for VSTs + + @tags{Audio} +*/ struct VstSpeakerConfiguration { int32 type; @@ -461,6 +501,10 @@ enum PresonusExtensionConstants }; //============================================================================== +/** Structure used for VSTs + + @tags{Audio} +*/ struct vst2FxBank { int32 magic1; diff --git a/modules/juce_audio_processors/format_types/juce_VSTMidiEventList.h b/modules/juce_audio_processors/format_types/juce_VSTMidiEventList.h index 6665cb9ae3..84c73d4d33 100644 --- a/modules/juce_audio_processors/format_types/juce_VSTMidiEventList.h +++ b/modules/juce_audio_processors/format_types/juce_VSTMidiEventList.h @@ -35,6 +35,8 @@ namespace juce events to the list. This is used by both the VST hosting code and the plugin wrapper. + + @tags{Audio} */ class VSTMidiEventList { diff --git a/modules/juce_audio_processors/format_types/juce_VSTPluginFormat.h b/modules/juce_audio_processors/format_types/juce_VSTPluginFormat.h index 1edeb83e1e..5298dc835d 100644 --- a/modules/juce_audio_processors/format_types/juce_VSTPluginFormat.h +++ b/modules/juce_audio_processors/format_types/juce_VSTPluginFormat.h @@ -32,6 +32,8 @@ namespace juce //============================================================================== /** Implements a plugin format manager for VSTs. + + @tags{Audio} */ class JUCE_API VSTPluginFormat : public AudioPluginFormat { diff --git a/modules/juce_audio_processors/processors/juce_AudioPluginInstance.h b/modules/juce_audio_processors/processors/juce_AudioPluginInstance.h index 9cdc697b69..5888a6102d 100644 --- a/modules/juce_audio_processors/processors/juce_AudioPluginInstance.h +++ b/modules/juce_audio_processors/processors/juce_AudioPluginInstance.h @@ -39,6 +39,8 @@ namespace juce return AudioPluginInstance objects which wrap external plugins. @see AudioProcessor, AudioPluginFormat + + @tags{Audio} */ class JUCE_API AudioPluginInstance : public AudioProcessor { @@ -96,6 +98,7 @@ public: protected: //============================================================================== + /** Structure used to describe plugin parameters */ struct Parameter : public AudioProcessorParameter { Parameter(); diff --git a/modules/juce_audio_processors/processors/juce_AudioProcessor.h b/modules/juce_audio_processors/processors/juce_AudioProcessor.h index a845fd2ffd..c2c2cb633f 100644 --- a/modules/juce_audio_processors/processors/juce_AudioProcessor.h +++ b/modules/juce_audio_processors/processors/juce_AudioProcessor.h @@ -40,6 +40,8 @@ namespace juce You should derive your own class from this base class, and if you're building a plugin, you should implement a global function called createPluginFilter() which creates and returns a new instance of your subclass. + + @tags{Audio} */ class JUCE_API AudioProcessor { @@ -1480,6 +1482,7 @@ protected: bool isActivatedByDefault; }; + /** Structure used for AudioProcessor Callbacks */ struct BusesProperties { /** The layouts of the input buses */ diff --git a/modules/juce_audio_processors/processors/juce_AudioProcessorEditor.h b/modules/juce_audio_processors/processors/juce_AudioProcessorEditor.h index 0b65f0400b..1d126a8abe 100644 --- a/modules/juce_audio_processors/processors/juce_AudioProcessorEditor.h +++ b/modules/juce_audio_processors/processors/juce_AudioProcessorEditor.h @@ -38,6 +38,8 @@ class AudioProcessorEditorListener; by overriding the AudioProcessor::createEditor() method. @see AudioProcessor, GenericAudioProcessorEditor + + @tags{Audio} */ class JUCE_API AudioProcessorEditor : public Component { diff --git a/modules/juce_audio_processors/processors/juce_AudioProcessorGraph.h b/modules/juce_audio_processors/processors/juce_AudioProcessorGraph.h index 6b9393c3a2..0fac99ced1 100644 --- a/modules/juce_audio_processors/processors/juce_AudioProcessorGraph.h +++ b/modules/juce_audio_processors/processors/juce_AudioProcessorGraph.h @@ -40,6 +40,8 @@ namespace juce To play back a graph through an audio device, you might want to use an AudioProcessorPlayer object. + + @tags{Audio} */ class JUCE_API AudioProcessorGraph : public AudioProcessor, public ChangeBroadcaster, diff --git a/modules/juce_audio_processors/processors/juce_AudioProcessorListener.h b/modules/juce_audio_processors/processors/juce_AudioProcessorListener.h index 7781af1fec..9116a44035 100644 --- a/modules/juce_audio_processors/processors/juce_AudioProcessorListener.h +++ b/modules/juce_audio_processors/processors/juce_AudioProcessorListener.h @@ -34,6 +34,8 @@ namespace juce Use AudioProcessor::addListener() to register your listener with an AudioProcessor. @see AudioProcessor + + @tags{Audio} */ class JUCE_API AudioProcessorListener { diff --git a/modules/juce_audio_processors/processors/juce_AudioProcessorParameter.h b/modules/juce_audio_processors/processors/juce_AudioProcessorParameter.h index b2c26bd5e1..98fd08ad82 100644 --- a/modules/juce_audio_processors/processors/juce_AudioProcessorParameter.h +++ b/modules/juce_audio_processors/processors/juce_AudioProcessorParameter.h @@ -32,6 +32,8 @@ namespace juce AudioProcessor. @see AudioProcessor::addParameter + + @tags{Audio} */ class JUCE_API AudioProcessorParameter { diff --git a/modules/juce_audio_processors/processors/juce_GenericAudioProcessorEditor.h b/modules/juce_audio_processors/processors/juce_GenericAudioProcessorEditor.h index d3be5184b5..9945f20b5e 100644 --- a/modules/juce_audio_processors/processors/juce_GenericAudioProcessorEditor.h +++ b/modules/juce_audio_processors/processors/juce_GenericAudioProcessorEditor.h @@ -36,6 +36,8 @@ namespace juce its own custom editor. @see AudioProcessor + + @tags{Audio} */ class JUCE_API GenericAudioProcessorEditor : public AudioProcessorEditor { diff --git a/modules/juce_audio_processors/processors/juce_PluginDescription.h b/modules/juce_audio_processors/processors/juce_PluginDescription.h index 7642545a10..bb7f8653dc 100644 --- a/modules/juce_audio_processors/processors/juce_PluginDescription.h +++ b/modules/juce_audio_processors/processors/juce_PluginDescription.h @@ -37,6 +37,8 @@ namespace juce A KnownPluginList contains a list of PluginDescription objects. @see KnownPluginList + + @tags{Audio} */ class JUCE_API PluginDescription { diff --git a/modules/juce_audio_processors/scanning/juce_KnownPluginList.h b/modules/juce_audio_processors/scanning/juce_KnownPluginList.h index 2d34a0e3d4..cb5cb632f2 100644 --- a/modules/juce_audio_processors/scanning/juce_KnownPluginList.h +++ b/modules/juce_audio_processors/scanning/juce_KnownPluginList.h @@ -35,6 +35,8 @@ namespace juce the plugin types in it. @see PluginListComponent + + @tags{Audio} */ class JUCE_API KnownPluginList : public ChangeBroadcaster { @@ -185,6 +187,7 @@ public: PluginTree* createTree (const SortMethod sortMethod) const; //============================================================================== + /** Class to define a custom plugin scanner */ class CustomScanner { public: diff --git a/modules/juce_audio_processors/scanning/juce_PluginDirectoryScanner.h b/modules/juce_audio_processors/scanning/juce_PluginDirectoryScanner.h index b27f70a27b..c26ef9b8a2 100644 --- a/modules/juce_audio_processors/scanning/juce_PluginDirectoryScanner.h +++ b/modules/juce_audio_processors/scanning/juce_PluginDirectoryScanner.h @@ -33,6 +33,8 @@ namespace juce To use one of these, create it and call scanNextFile() repeatedly, until it returns false. + + @tags{Audio} */ class JUCE_API PluginDirectoryScanner { diff --git a/modules/juce_audio_processors/scanning/juce_PluginListComponent.h b/modules/juce_audio_processors/scanning/juce_PluginListComponent.h index e0406751b1..a34b4ad571 100644 --- a/modules/juce_audio_processors/scanning/juce_PluginListComponent.h +++ b/modules/juce_audio_processors/scanning/juce_PluginListComponent.h @@ -31,6 +31,8 @@ namespace juce /** A component displaying a list of plugins, with options to scan for them, add, remove and sort them. + + @tags{Audio} */ class JUCE_API PluginListComponent : public Component, public FileDragAndDropTarget, diff --git a/modules/juce_audio_processors/utilities/juce_AudioParameterBool.h b/modules/juce_audio_processors/utilities/juce_AudioParameterBool.h index 9224d2695d..fd010ed528 100644 --- a/modules/juce_audio_processors/utilities/juce_AudioParameterBool.h +++ b/modules/juce_audio_processors/utilities/juce_AudioParameterBool.h @@ -31,6 +31,8 @@ namespace juce Provides a class of AudioProcessorParameter that can be used as a boolean value. @see AudioParameterFloat, AudioParameterInt, AudioParameterChoice + + @tags{Audio} */ class JUCE_API AudioParameterBool : public AudioProcessorParameterWithID { diff --git a/modules/juce_audio_processors/utilities/juce_AudioParameterChoice.h b/modules/juce_audio_processors/utilities/juce_AudioParameterChoice.h index 24e25cc313..7abd04ecad 100644 --- a/modules/juce_audio_processors/utilities/juce_AudioParameterChoice.h +++ b/modules/juce_audio_processors/utilities/juce_AudioParameterChoice.h @@ -32,6 +32,8 @@ namespace juce an indexed, named choice from a list. @see AudioParameterFloat, AudioParameterInt, AudioParameterBool + + @tags{Audio} */ class JUCE_API AudioParameterChoice : public AudioProcessorParameterWithID { diff --git a/modules/juce_audio_processors/utilities/juce_AudioParameterFloat.h b/modules/juce_audio_processors/utilities/juce_AudioParameterFloat.h index b09cb20571..6193d7f9ab 100644 --- a/modules/juce_audio_processors/utilities/juce_AudioParameterFloat.h +++ b/modules/juce_audio_processors/utilities/juce_AudioParameterFloat.h @@ -32,6 +32,8 @@ namespace juce parameter which maps onto a given NormalisableRange. @see AudioParameterInt, AudioParameterBool, AudioParameterChoice + + @tags{Audio} */ class JUCE_API AudioParameterFloat : public AudioProcessorParameterWithID { diff --git a/modules/juce_audio_processors/utilities/juce_AudioParameterInt.h b/modules/juce_audio_processors/utilities/juce_AudioParameterInt.h index 61f8e77f3d..17feac122a 100644 --- a/modules/juce_audio_processors/utilities/juce_AudioParameterInt.h +++ b/modules/juce_audio_processors/utilities/juce_AudioParameterInt.h @@ -32,6 +32,8 @@ namespace juce integer value with a given range. @see AudioParameterFloat, AudioParameterBool, AudioParameterChoice + + @tags{Audio} */ class JUCE_API AudioParameterInt : public AudioProcessorParameterWithID { diff --git a/modules/juce_audio_processors/utilities/juce_AudioProcessorParameterWithID.h b/modules/juce_audio_processors/utilities/juce_AudioProcessorParameterWithID.h index d5d0052349..607958e59b 100644 --- a/modules/juce_audio_processors/utilities/juce_AudioProcessorParameterWithID.h +++ b/modules/juce_audio_processors/utilities/juce_AudioProcessorParameterWithID.h @@ -31,6 +31,8 @@ namespace juce This abstract base class is used by some AudioProcessorParameter helper classes. @see AudioParameterFloat, AudioParameterInt, AudioParameterBool, AudioParameterChoice + + @tags{Audio} */ class JUCE_API AudioProcessorParameterWithID : public AudioProcessorParameter { diff --git a/modules/juce_audio_processors/utilities/juce_AudioProcessorValueTreeState.h b/modules/juce_audio_processors/utilities/juce_AudioProcessorValueTreeState.h index cf1983d3cd..9813eed1b7 100644 --- a/modules/juce_audio_processors/utilities/juce_AudioProcessorValueTreeState.h +++ b/modules/juce_audio_processors/utilities/juce_AudioProcessorValueTreeState.h @@ -42,6 +42,8 @@ namespace juce To use: 1) Create an AudioProcessorValueTreeState, and give it some parameters using createAndAddParameter(). 2) Initialise the state member variable with a type name. + + @tags{Audio} */ class JUCE_API AudioProcessorValueTreeState : private Timer, private ValueTree::Listener diff --git a/modules/juce_audio_utils/audio_cd/juce_AudioCDBurner.h b/modules/juce_audio_utils/audio_cd/juce_AudioCDBurner.h index ad583d4c6e..f75df9a194 100644 --- a/modules/juce_audio_utils/audio_cd/juce_AudioCDBurner.h +++ b/modules/juce_audio_utils/audio_cd/juce_AudioCDBurner.h @@ -32,6 +32,8 @@ namespace juce //============================================================================== /** + + @tags{Audio} */ class AudioCDBurner : public ChangeBroadcaster { diff --git a/modules/juce_audio_utils/audio_cd/juce_AudioCDReader.h b/modules/juce_audio_utils/audio_cd/juce_AudioCDReader.h index 540754c6c4..175cf06b2c 100644 --- a/modules/juce_audio_utils/audio_cd/juce_AudioCDReader.h +++ b/modules/juce_audio_utils/audio_cd/juce_AudioCDReader.h @@ -39,6 +39,8 @@ namespace juce within the stream. @see AudioFormatReader + + @tags{Audio} */ class JUCE_API AudioCDReader : public AudioFormatReader { diff --git a/modules/juce_audio_utils/gui/juce_AudioAppComponent.h b/modules/juce_audio_utils/gui/juce_AudioAppComponent.h index 238439e8a0..10789aadba 100644 --- a/modules/juce_audio_utils/gui/juce_AudioAppComponent.h +++ b/modules/juce_audio_utils/gui/juce_AudioAppComponent.h @@ -42,6 +42,8 @@ namespace juce This class should not be inherited when creating a plug-in as the host will handle audio streams from hardware devices. + + @tags{Audio} */ class JUCE_API AudioAppComponent : public Component, public AudioSource diff --git a/modules/juce_audio_utils/gui/juce_AudioDeviceSelectorComponent.h b/modules/juce_audio_utils/gui/juce_AudioDeviceSelectorComponent.h index 2172605da0..e90ee5f66e 100644 --- a/modules/juce_audio_utils/gui/juce_AudioDeviceSelectorComponent.h +++ b/modules/juce_audio_utils/gui/juce_AudioDeviceSelectorComponent.h @@ -35,6 +35,8 @@ namespace juce Very easy to use - just create one of these and show it to the user. @see AudioDeviceManager + + @tags{Audio} */ class JUCE_API AudioDeviceSelectorComponent : public Component, private ChangeListener, diff --git a/modules/juce_audio_utils/gui/juce_AudioThumbnail.h b/modules/juce_audio_utils/gui/juce_AudioThumbnail.h index ae40ef7f06..ed7ab0e22a 100644 --- a/modules/juce_audio_utils/gui/juce_AudioThumbnail.h +++ b/modules/juce_audio_utils/gui/juce_AudioThumbnail.h @@ -45,6 +45,8 @@ namespace juce be loaded and saved to avoid having to scan the file again. @see AudioThumbnailCache, AudioThumbnailBase + + @tags{Audio} */ class JUCE_API AudioThumbnail : public AudioThumbnailBase { diff --git a/modules/juce_audio_utils/gui/juce_AudioThumbnailBase.h b/modules/juce_audio_utils/gui/juce_AudioThumbnailBase.h index 2ee81e4a44..b4123096b9 100644 --- a/modules/juce_audio_utils/gui/juce_AudioThumbnailBase.h +++ b/modules/juce_audio_utils/gui/juce_AudioThumbnailBase.h @@ -38,6 +38,8 @@ class AudioThumbnailCache; a concrete implementation. @see AudioThumbnail, AudioThumbnailCache + + @tags{Audio} */ class JUCE_API AudioThumbnailBase : public ChangeBroadcaster, public AudioFormatWriter::ThreadedWriter::IncomingDataReceiver diff --git a/modules/juce_audio_utils/gui/juce_AudioThumbnailCache.h b/modules/juce_audio_utils/gui/juce_AudioThumbnailCache.h index 60057a6480..b3ab04107b 100644 --- a/modules/juce_audio_utils/gui/juce_AudioThumbnailCache.h +++ b/modules/juce_audio_utils/gui/juce_AudioThumbnailCache.h @@ -36,6 +36,8 @@ namespace juce having to re-scan audio files too often. @see AudioThumbnail + + @tags{Audio} */ class JUCE_API AudioThumbnailCache { diff --git a/modules/juce_audio_utils/gui/juce_AudioVisualiserComponent.h b/modules/juce_audio_utils/gui/juce_AudioVisualiserComponent.h index ee3c5a9f52..f08292a38a 100644 --- a/modules/juce_audio_utils/gui/juce_AudioVisualiserComponent.h +++ b/modules/juce_audio_utils/gui/juce_AudioVisualiserComponent.h @@ -40,6 +40,8 @@ namespace juce for fancy additional features that you'd like it to support! If you're building a real-world app that requires more powerful waveform display, you'll probably want to create your own component instead. + + @tags{Audio} */ class JUCE_API AudioVisualiserComponent : public Component, private Timer diff --git a/modules/juce_audio_utils/gui/juce_BluetoothMidiDevicePairingDialogue.h b/modules/juce_audio_utils/gui/juce_BluetoothMidiDevicePairingDialogue.h index 96d64e4e58..647c6472a2 100644 --- a/modules/juce_audio_utils/gui/juce_BluetoothMidiDevicePairingDialogue.h +++ b/modules/juce_audio_utils/gui/juce_BluetoothMidiDevicePairingDialogue.h @@ -42,8 +42,9 @@ namespace juce app (located in /Applications/Utilities). On Windows, you should use the system settings. On Linux, Bluetooth MIDI devices are currently not supported. -*/ + @tags{Audio} +*/ class JUCE_API BluetoothMidiDevicePairingDialogue { public: diff --git a/modules/juce_audio_utils/gui/juce_MidiKeyboardComponent.h b/modules/juce_audio_utils/gui/juce_MidiKeyboardComponent.h index 981da4216e..dbbb4d7a10 100644 --- a/modules/juce_audio_utils/gui/juce_MidiKeyboardComponent.h +++ b/modules/juce_audio_utils/gui/juce_MidiKeyboardComponent.h @@ -44,6 +44,8 @@ namespace juce keyboard is scrolled, you can register a ChangeListener for callbacks. @see MidiKeyboardState + + @tags{Audio} */ class JUCE_API MidiKeyboardComponent : public Component, public MidiKeyboardStateListener, diff --git a/modules/juce_audio_utils/players/juce_AudioProcessorPlayer.h b/modules/juce_audio_utils/players/juce_AudioProcessorPlayer.h index d93956474a..198641e6c5 100644 --- a/modules/juce_audio_utils/players/juce_AudioProcessorPlayer.h +++ b/modules/juce_audio_utils/players/juce_AudioProcessorPlayer.h @@ -38,6 +38,8 @@ namespace juce input to send both streams through the processor. @see AudioProcessor, AudioProcessorGraph + + @tags{Audio} */ class JUCE_API AudioProcessorPlayer : public AudioIODeviceCallback, public MidiInputCallback diff --git a/modules/juce_audio_utils/players/juce_SoundPlayer.h b/modules/juce_audio_utils/players/juce_SoundPlayer.h index 8c9ca6db1c..205362b4a7 100644 --- a/modules/juce_audio_utils/players/juce_SoundPlayer.h +++ b/modules/juce_audio_utils/players/juce_SoundPlayer.h @@ -33,6 +33,8 @@ namespace juce simple sounds. @see AudioProcessor, AudioProcessorGraph + + @tags{Audio} */ class JUCE_API SoundPlayer : public AudioIODeviceCallback { diff --git a/modules/juce_blocks_basics/blocks/juce_Block.h b/modules/juce_blocks_basics/blocks/juce_Block.h index 6e58077c19..f0c7bc6b31 100644 --- a/modules/juce_blocks_basics/blocks/juce_Block.h +++ b/modules/juce_blocks_basics/blocks/juce_Block.h @@ -25,6 +25,8 @@ namespace juce /** Represents an individual BLOCKS device. + + @tags{Blocks} */ class Block : public juce::ReferenceCountedObject { diff --git a/modules/juce_blocks_basics/blocks/juce_BlockConfigManager.h b/modules/juce_blocks_basics/blocks/juce_BlockConfigManager.h index f24540ded4..84320b0f52 100644 --- a/modules/juce_blocks_basics/blocks/juce_BlockConfigManager.h +++ b/modules/juce_blocks_basics/blocks/juce_BlockConfigManager.h @@ -36,6 +36,10 @@ namespace juce using namespace BlocksProtocol; +/** Manages the configuration of blocks + + @tags{Blocks} +*/ struct BlockConfigManager { void setDeviceIndex (TopologyIndex newDeviceIndex) { deviceIndex = newDeviceIndex; } @@ -52,6 +56,7 @@ struct BlockConfigManager static constexpr uint32 numConfigItems = 61; + /** Structure describing a configuration */ struct ConfigDescription { ConfigItemId item; diff --git a/modules/juce_blocks_basics/blocks/juce_ControlButton.h b/modules/juce_blocks_basics/blocks/juce_ControlButton.h index 2dc28a08ac..f65cec1ec7 100644 --- a/modules/juce_blocks_basics/blocks/juce_ControlButton.h +++ b/modules/juce_blocks_basics/blocks/juce_ControlButton.h @@ -25,6 +25,8 @@ namespace juce /** Represents a button on a block device. + + @tags{Blocks} */ class ControlButton { diff --git a/modules/juce_blocks_basics/blocks/juce_LEDGrid.h b/modules/juce_blocks_basics/blocks/juce_LEDGrid.h index 326627349e..f6c84f4277 100644 --- a/modules/juce_blocks_basics/blocks/juce_LEDGrid.h +++ b/modules/juce_blocks_basics/blocks/juce_LEDGrid.h @@ -25,6 +25,8 @@ namespace juce /** A simple ARGB colour class for setting LEDs. + + @tags{Blocks} */ struct LEDColour { @@ -51,6 +53,8 @@ struct LEDColour //============================================================================== /** Represents a 2D grid of LEDs on a block device. + + @tags{Blocks} */ class LEDGrid { diff --git a/modules/juce_blocks_basics/blocks/juce_LEDRow.h b/modules/juce_blocks_basics/blocks/juce_LEDRow.h index e32083985e..c5e4eb54cb 100644 --- a/modules/juce_blocks_basics/blocks/juce_LEDRow.h +++ b/modules/juce_blocks_basics/blocks/juce_LEDRow.h @@ -25,6 +25,8 @@ namespace juce /** Represents an LED strip on a device. + + @tags{Blocks} */ class LEDRow { diff --git a/modules/juce_blocks_basics/blocks/juce_StatusLight.h b/modules/juce_blocks_basics/blocks/juce_StatusLight.h index 79d13ca54a..e644090593 100644 --- a/modules/juce_blocks_basics/blocks/juce_StatusLight.h +++ b/modules/juce_blocks_basics/blocks/juce_StatusLight.h @@ -25,6 +25,8 @@ namespace juce /** Represents a status LED on a device. + + @tags{Blocks} */ class StatusLight { diff --git a/modules/juce_blocks_basics/blocks/juce_TouchList.h b/modules/juce_blocks_basics/blocks/juce_TouchList.h index d532492d88..add44ccb28 100644 --- a/modules/juce_blocks_basics/blocks/juce_TouchList.h +++ b/modules/juce_blocks_basics/blocks/juce_TouchList.h @@ -30,6 +30,8 @@ namespace juce The Type template is a user-defined type of object that will be stored for each touch element. The type must be default-constructable and copyable. + + @tags{Blocks} */ template class TouchList diff --git a/modules/juce_blocks_basics/blocks/juce_TouchSurface.h b/modules/juce_blocks_basics/blocks/juce_TouchSurface.h index e0f173cbe2..1b83f8f31b 100644 --- a/modules/juce_blocks_basics/blocks/juce_TouchSurface.h +++ b/modules/juce_blocks_basics/blocks/juce_TouchSurface.h @@ -25,6 +25,8 @@ namespace juce /** Represents the touch surface of a BLOCKS device. + + @tags{Blocks} */ class TouchSurface { @@ -35,6 +37,7 @@ public: virtual ~TouchSurface(); //============================================================================== + /** Structure used to describe touch properties */ struct Touch { /** A touch index, which will stay constant for each finger as it is tracked. */ diff --git a/modules/juce_blocks_basics/littlefoot/juce_LittleFootCompiler.h b/modules/juce_blocks_basics/littlefoot/juce_LittleFootCompiler.h index 3fdf85a243..1e96326e85 100644 --- a/modules/juce_blocks_basics/littlefoot/juce_LittleFootCompiler.h +++ b/modules/juce_blocks_basics/littlefoot/juce_LittleFootCompiler.h @@ -31,6 +31,8 @@ namespace littlefoot /** This class compiles littlefoot source code into a littlefoot::Program object which can be executed by a littlefoot::Runner. + + @tags{Blocks} */ struct Compiler { @@ -91,6 +93,9 @@ struct Compiler Array compiledObjectCode; private: + + #ifndef DOXYGEN + struct Statement; struct Expression; struct BlockStatement; @@ -2192,6 +2197,8 @@ private: if (v.isBool()) return Type::bool_; return Type::void_; } + + #endif // ! DOXYGEN }; } diff --git a/modules/juce_blocks_basics/littlefoot/juce_LittleFootRemoteHeap.h b/modules/juce_blocks_basics/littlefoot/juce_LittleFootRemoteHeap.h index 40d07c103d..92609aa8f1 100644 --- a/modules/juce_blocks_basics/littlefoot/juce_LittleFootRemoteHeap.h +++ b/modules/juce_blocks_basics/littlefoot/juce_LittleFootRemoteHeap.h @@ -30,6 +30,8 @@ namespace littlefoot Data in the block can be changed by calling setByte, setBytes, setBits etc, and these changes will be flushed to the device when sendChanges is called. + + @tags{Blocks} */ template struct LittleFootRemoteHeap diff --git a/modules/juce_blocks_basics/littlefoot/juce_LittleFootRunner.h b/modules/juce_blocks_basics/littlefoot/juce_LittleFootRunner.h index 6a4a616569..0091e6f7f4 100644 --- a/modules/juce_blocks_basics/littlefoot/juce_LittleFootRunner.h +++ b/modules/juce_blocks_basics/littlefoot/juce_LittleFootRunner.h @@ -131,7 +131,10 @@ enum class Type : uint8 }; //============================================================================== -/** Defines a native function that the program can call. */ +/** Defines a native function that the program can call. + + @tags{Blocks} +*/ struct NativeFunction { using ImplementationFunction = int32 (*) (void*, const int32*); @@ -209,6 +212,8 @@ private: 2 bytes - byte offset of function 2 code etc.. ...function code... + + @tags{Blocks} */ struct Program { @@ -406,6 +411,8 @@ private: Program code goes at address 0, followed by any shared data the program needs globals are at the top end of the buffer stack space stretches downwards from the start of the globals + + @tags{Blocks} */ template struct Runner diff --git a/modules/juce_blocks_basics/protocol/juce_BitPackingUtilities.h b/modules/juce_blocks_basics/protocol/juce_BitPackingUtilities.h index 4d122d6486..92048566e6 100644 --- a/modules/juce_blocks_basics/protocol/juce_BitPackingUtilities.h +++ b/modules/juce_blocks_basics/protocol/juce_BitPackingUtilities.h @@ -46,6 +46,11 @@ static uint8 calculatePacketChecksum (const uint8* data, uint32 size) noexcept //============================================================================== +/** + Helper class to define an integer with a specific bit size. + + @tags{Blocks} +*/ template struct IntegerWithBitSize { @@ -96,6 +101,8 @@ struct IntegerWithBitSize /** This helper class allocates a block of 7-bit bytes and can push sequences of bits into it. @see Packed7BitArrayReader + + @tags{Blocks} */ template struct Packed7BitArrayBuilder @@ -188,6 +195,7 @@ struct Packed7BitArrayBuilder } } + /** Describes the current building state */ struct State { int bytesWritten, bitsInCurrentByte; @@ -214,6 +222,8 @@ private: /** This helper class reads from a block of 7-bit bytes as sequences of bits. @see Packed7BitArrayBuilder + + @tags{Blocks} */ struct Packed7BitArrayReader { diff --git a/modules/juce_blocks_basics/protocol/juce_BlockModels.h b/modules/juce_blocks_basics/protocol/juce_BlockModels.h index e809c880d1..74cd935115 100644 --- a/modules/juce_blocks_basics/protocol/juce_BlockModels.h +++ b/modules/juce_blocks_basics/protocol/juce_BlockModels.h @@ -25,9 +25,10 @@ namespace juce namespace BlocksProtocol { +#ifndef DOXYGEN + // This file isn't part of the public API, it's where we encode the knowledge base // of all the different types of block we know about.. - struct BlockDataSheet { BlockDataSheet (const BlocksProtocol::BlockSerialNumber& serial) : serialNumber (serial) @@ -317,5 +318,7 @@ static const char* getButtonNameForFunction (ControlButton::ButtonFunction fn) n return nullptr; } +#endif + } // namespace BlocksProtocol } // namespace juce diff --git a/modules/juce_blocks_basics/protocol/juce_BlocksProtocolDefinitions.h b/modules/juce_blocks_basics/protocol/juce_BlocksProtocolDefinitions.h index ed0f7d5f36..c74b63560e 100644 --- a/modules/juce_blocks_basics/protocol/juce_BlocksProtocolDefinitions.h +++ b/modules/juce_blocks_basics/protocol/juce_BlocksProtocolDefinitions.h @@ -124,6 +124,10 @@ using BatteryCharging = IntegerWithBitSize<1>; using ConnectorPort = IntegerWithBitSize<5>; //============================================================================== +/** Structure describing a block's serial number + + @tags{Blocks} +*/ struct BlockSerialNumber { uint8 serial[16]; @@ -149,18 +153,30 @@ struct BlockSerialNumber bool hasPrefix (const char* prefix) const noexcept { return memcmp (serial, prefix, 3) == 0; } }; +/** Structure for the version number + + @tags{Blocks} +*/ struct VersionNumber { uint8 version[21] = {}; uint8 length = 0; }; +/** Structure for the block name + + @tags{Blocks} +*/ struct BlockName { uint8 name[33] = {}; uint8 length = 0; }; +/** Structure for the device status + + @tags{Blocks} +*/ struct DeviceStatus { BlockSerialNumber serialNumber; @@ -169,18 +185,30 @@ struct DeviceStatus BatteryCharging batteryCharging; }; +/** Structure for the device connection + + @tags{Blocks} +*/ struct DeviceConnection { TopologyIndex device1, device2; ConnectorPort port1, port2; }; +/** Structure for the device version + + @tags{Blocks} +*/ struct DeviceVersion { TopologyIndex index; VersionNumber version; }; +/** Structure used for the device name + + @tags{Blocks} +*/ struct DeviceName { TopologyIndex index; @@ -272,7 +300,10 @@ static constexpr uint8 configMaxOptions = 8; static constexpr uint8 configOptionNameLength = 16; //============================================================================== -/** The coordinates of a touch. */ +/** The coordinates of a touch. + + @tags{Blocks} +*/ struct TouchPosition { using Xcoord = IntegerWithBitSize<12>; @@ -286,7 +317,10 @@ struct TouchPosition enum { bits = Xcoord::bits + Ycoord::bits + Zcoord::bits }; }; -/** The velocities for each dimension of a touch. */ +/** The velocities for each dimension of a touch. + + @tags{Blocks} +*/ struct TouchVelocity { using VXcoord = IntegerWithBitSize<8>; diff --git a/modules/juce_blocks_basics/protocol/juce_HostPacketBuilder.h b/modules/juce_blocks_basics/protocol/juce_HostPacketBuilder.h index 2a2841651e..8e8585390e 100644 --- a/modules/juce_blocks_basics/protocol/juce_HostPacketBuilder.h +++ b/modules/juce_blocks_basics/protocol/juce_HostPacketBuilder.h @@ -27,6 +27,8 @@ namespace BlocksProtocol /** Helper class for constructing a packet for sending to a BLOCKS device + + @tags{Blocks} */ template struct HostPacketBuilder diff --git a/modules/juce_blocks_basics/protocol/juce_HostPacketDecoder.h b/modules/juce_blocks_basics/protocol/juce_HostPacketDecoder.h index 16142ae793..ddac5af1ee 100644 --- a/modules/juce_blocks_basics/protocol/juce_HostPacketDecoder.h +++ b/modules/juce_blocks_basics/protocol/juce_HostPacketDecoder.h @@ -28,6 +28,8 @@ namespace BlocksProtocol /** Parses data packets from a BLOCKS device, and translates them into callbacks on a handler object + + @tags{Blocks} */ template struct HostPacketDecoder diff --git a/modules/juce_blocks_basics/topology/juce_PhysicalTopologySource.h b/modules/juce_blocks_basics/topology/juce_PhysicalTopologySource.h index 442e78e28a..6cdc80aec3 100644 --- a/modules/juce_blocks_basics/topology/juce_PhysicalTopologySource.h +++ b/modules/juce_blocks_basics/topology/juce_PhysicalTopologySource.h @@ -27,6 +27,8 @@ namespace juce This topology source manages the topology of the physical Blocks devices that are currently connected. It maintains a list of them and tells listeners when physical devices are added or removed. + + @tags{Blocks} */ class PhysicalTopologySource : public TopologySource { diff --git a/modules/juce_blocks_basics/topology/juce_RuleBasedTopologySource.h b/modules/juce_blocks_basics/topology/juce_RuleBasedTopologySource.h index 7b155a1d89..f21f1dfa59 100644 --- a/modules/juce_blocks_basics/topology/juce_RuleBasedTopologySource.h +++ b/modules/juce_blocks_basics/topology/juce_RuleBasedTopologySource.h @@ -29,6 +29,8 @@ namespace juce Given an input PhysicalTopologySource and a set of Rule objects, this class will apply the rules and present the resulting topology to clients. + + @tags{Blocks} */ class RuleBasedTopologySource : public TopologySource { diff --git a/modules/juce_blocks_basics/topology/juce_Topology.h b/modules/juce_blocks_basics/topology/juce_Topology.h index 2c846a036f..8f0868c15b 100644 --- a/modules/juce_blocks_basics/topology/juce_Topology.h +++ b/modules/juce_blocks_basics/topology/juce_Topology.h @@ -23,7 +23,10 @@ namespace juce { -/** Describes a phyiscal connection between two ports of two block devices. */ +/** Describes a phyiscal connection between two ports of two block devices. + + @tags{Blocks} +*/ struct BlockDeviceConnection { Block::UID device1, device2; @@ -34,7 +37,10 @@ struct BlockDeviceConnection }; -/** Describes a set of blocks and the connections between them. */ +/** Describes a set of blocks and the connections between them. + + @tags{Blocks} +*/ struct BlockTopology { Block::Array blocks; diff --git a/modules/juce_blocks_basics/topology/juce_TopologySource.h b/modules/juce_blocks_basics/topology/juce_TopologySource.h index f0b5bdbc6c..f558c6decb 100644 --- a/modules/juce_blocks_basics/topology/juce_TopologySource.h +++ b/modules/juce_blocks_basics/topology/juce_TopologySource.h @@ -23,7 +23,10 @@ namespace juce { -/** Base class for an entity that provides access to a blocks topology. */ +/** Base class for an entity that provides access to a blocks topology. + + @tags{Blocks} +*/ class TopologySource { public: @@ -35,6 +38,7 @@ public: virtual BlockTopology getCurrentTopology() const = 0; //========================================================================== + /** Used to receive callbacks for topology changes */ struct Listener { virtual ~Listener() {} diff --git a/modules/juce_blocks_basics/visualisers/juce_BitmapLEDProgram.h b/modules/juce_blocks_basics/visualisers/juce_BitmapLEDProgram.h index 795c7eca7c..9256b1548b 100644 --- a/modules/juce_blocks_basics/visualisers/juce_BitmapLEDProgram.h +++ b/modules/juce_blocks_basics/visualisers/juce_BitmapLEDProgram.h @@ -25,6 +25,8 @@ namespace juce /** A simple Program to set the colours of individual LEDs. + + @tags{Blocks} */ struct BitmapLEDProgram : public Block::Program { diff --git a/modules/juce_blocks_basics/visualisers/juce_DrumPadLEDProgram.h b/modules/juce_blocks_basics/visualisers/juce_DrumPadLEDProgram.h index b45f235734..e3821791b2 100644 --- a/modules/juce_blocks_basics/visualisers/juce_DrumPadLEDProgram.h +++ b/modules/juce_blocks_basics/visualisers/juce_DrumPadLEDProgram.h @@ -24,6 +24,7 @@ namespace juce { /** + @tags{Blocks} */ struct DrumPadGridProgram : public Block::Program { diff --git a/modules/juce_box2d/utils/juce_Box2DRenderer.h b/modules/juce_box2d/utils/juce_Box2DRenderer.h index 89d56db9a2..e7ec4944e3 100644 --- a/modules/juce_box2d/utils/juce_Box2DRenderer.h +++ b/modules/juce_box2d/utils/juce_Box2DRenderer.h @@ -32,6 +32,8 @@ namespace juce To use it, simply create an instance of this class in your paint() method, and call its render() method. + + @tags{Box2D} */ class Box2DRenderer : public b2Draw diff --git a/modules/juce_core/containers/juce_AbstractFifo.h b/modules/juce_core/containers/juce_AbstractFifo.h index c9b24aacfc..6638e94935 100644 --- a/modules/juce_core/containers/juce_AbstractFifo.h +++ b/modules/juce_core/containers/juce_AbstractFifo.h @@ -78,6 +78,8 @@ namespace juce int myBuffer [1024]; }; @endcode + + @tags{Core} */ class JUCE_API AbstractFifo { @@ -210,6 +212,7 @@ private: }; public: + /** Class for a scoped reader/writer */ template class ScopedReadWrite final { diff --git a/modules/juce_core/containers/juce_Array.h b/modules/juce_core/containers/juce_Array.h index 8e98e2a209..cce599f4d0 100644 --- a/modules/juce_core/containers/juce_Array.h +++ b/modules/juce_core/containers/juce_Array.h @@ -46,6 +46,8 @@ namespace juce TypeOfCriticalSectionToUse parameter, instead of the default DummyCriticalSection. @see OwnedArray, ReferenceCountedArray, StringArray, CriticalSection + + @tags{Core} */ template class ArrayAllocationBase : public TypeOfCriticalSectionToUse diff --git a/modules/juce_core/containers/juce_DynamicObject.h b/modules/juce_core/containers/juce_DynamicObject.h index 83ee6ccf0e..0132fb10c5 100644 --- a/modules/juce_core/containers/juce_DynamicObject.h +++ b/modules/juce_core/containers/juce_DynamicObject.h @@ -33,6 +33,8 @@ namespace juce An instance of a DynamicObject can be used to store named properties, and by subclassing hasMethod() and invokeMethod(), you can give your object methods. + + @tags{Core} */ class JUCE_API DynamicObject : public ReferenceCountedObject { diff --git a/modules/juce_core/containers/juce_ElementComparator.h b/modules/juce_core/containers/juce_ElementComparator.h index d4e645ff57..6e0f24c2e3 100644 --- a/modules/juce_core/containers/juce_ElementComparator.h +++ b/modules/juce_core/containers/juce_ElementComparator.h @@ -28,6 +28,8 @@ namespace juce /** This is an internal helper class which converts a juce ElementComparator style class (using a "compareElements" method) into a class that's compatible with std::sort (i.e. using an operator() to compare the elements) + + @tags{Core} */ template struct SortFunctionConverter @@ -171,6 +173,8 @@ static int findInsertIndexInSortedArray (ElementComparator& comparator, @endcode @see ElementComparator + + @tags{Core} */ template class DefaultElementComparator diff --git a/modules/juce_core/containers/juce_HashMap.h b/modules/juce_core/containers/juce_HashMap.h index beff2438ea..c033b70060 100644 --- a/modules/juce_core/containers/juce_HashMap.h +++ b/modules/juce_core/containers/juce_HashMap.h @@ -28,6 +28,8 @@ namespace juce A simple class to generate hash functions for some primitive types, intended for use with the HashMap class. @see HashMap + + @tags{Core} */ struct DefaultHashFunctions { @@ -89,6 +91,8 @@ struct DefaultHashFunctions @tparam HashFunctionType The class of hash function, which must be copy-constructible. @see CriticalSection, DefaultHashFunctions, NamedValueSet, SortedSet + + @tags{Core} */ template class LinkedListPointer diff --git a/modules/juce_core/containers/juce_ListenerList.h b/modules/juce_core/containers/juce_ListenerList.h index d806189099..6e537ee879 100644 --- a/modules/juce_core/containers/juce_ListenerList.h +++ b/modules/juce_core/containers/juce_ListenerList.h @@ -60,6 +60,8 @@ namespace juce operation. For an example of a bail-out checker, see the Component::BailOutChecker class, which can be used to check when a Component has been deleted. See also ListenerList::DummyBailOutChecker, which is a dummy checker that always returns false. + + @tags{Core} */ template > diff --git a/modules/juce_core/containers/juce_NamedValueSet.h b/modules/juce_core/containers/juce_NamedValueSet.h index abd161a734..49089ec6b6 100644 --- a/modules/juce_core/containers/juce_NamedValueSet.h +++ b/modules/juce_core/containers/juce_NamedValueSet.h @@ -28,6 +28,8 @@ namespace juce This can be used as a basic structure to hold a set of var object, which can be retrieved by using their identifier. + + @tags{Core} */ class JUCE_API NamedValueSet { @@ -50,6 +52,7 @@ public: bool operator!= (const NamedValueSet&) const noexcept; //============================================================================== + /** Structure for a named var object */ struct JUCE_API NamedValue { NamedValue() noexcept; diff --git a/modules/juce_core/containers/juce_OwnedArray.h b/modules/juce_core/containers/juce_OwnedArray.h index aae1b80353..de71c7274a 100644 --- a/modules/juce_core/containers/juce_OwnedArray.h +++ b/modules/juce_core/containers/juce_OwnedArray.h @@ -41,6 +41,8 @@ namespace juce TypeOfCriticalSectionToUse parameter, instead of the default DummyCriticalSection. @see Array, ReferenceCountedArray, StringArray, CriticalSection + + @tags{Core} */ template diff --git a/modules/juce_core/containers/juce_PropertySet.h b/modules/juce_core/containers/juce_PropertySet.h index 26a2cad525..de4f4247f5 100644 --- a/modules/juce_core/containers/juce_PropertySet.h +++ b/modules/juce_core/containers/juce_PropertySet.h @@ -32,6 +32,8 @@ namespace juce See the PropertiesFile class for a subclass of this, which automatically broadcasts change messages and saves/loads the list from a file. + + @tags{Core} */ class JUCE_API PropertySet { diff --git a/modules/juce_core/containers/juce_ReferenceCountedArray.h b/modules/juce_core/containers/juce_ReferenceCountedArray.h index 123b23e88b..a70a1e0b95 100644 --- a/modules/juce_core/containers/juce_ReferenceCountedArray.h +++ b/modules/juce_core/containers/juce_ReferenceCountedArray.h @@ -43,6 +43,8 @@ namespace juce TypeOfCriticalSectionToUse parameter, instead of the default DummyCriticalSection. @see Array, OwnedArray, StringArray + + @tags{Core} */ template class ReferenceCountedArray diff --git a/modules/juce_core/containers/juce_ScopedValueSetter.h b/modules/juce_core/containers/juce_ScopedValueSetter.h index f5e03345a8..53f797dc08 100644 --- a/modules/juce_core/containers/juce_ScopedValueSetter.h +++ b/modules/juce_core/containers/juce_ScopedValueSetter.h @@ -48,6 +48,7 @@ namespace juce // x is now 4 @endcode + @tags{Core} */ template class ScopedValueSetter diff --git a/modules/juce_core/containers/juce_SortedSet.h b/modules/juce_core/containers/juce_SortedSet.h index 04d096a020..bf21793006 100644 --- a/modules/juce_core/containers/juce_SortedSet.h +++ b/modules/juce_core/containers/juce_SortedSet.h @@ -49,6 +49,8 @@ namespace juce TypeOfCriticalSectionToUse parameter, instead of the default DummyCriticalSection. @see Array, OwnedArray, ReferenceCountedArray, StringArray, CriticalSection + + @tags{Core} */ template class SortedSet diff --git a/modules/juce_core/containers/juce_SparseSet.h b/modules/juce_core/containers/juce_SparseSet.h index a206fa377d..077b8d6585 100644 --- a/modules/juce_core/containers/juce_SparseSet.h +++ b/modules/juce_core/containers/juce_SparseSet.h @@ -33,6 +33,8 @@ namespace juce The type used as a template parameter must be an integer type, such as int, short, int64, etc. + + @tags{Core} */ template class SparseSet diff --git a/modules/juce_core/containers/juce_Variant.h b/modules/juce_core/containers/juce_Variant.h index 73cd37bb4e..ca5d8c73d6 100644 --- a/modules/juce_core/containers/juce_Variant.h +++ b/modules/juce_core/containers/juce_Variant.h @@ -35,6 +35,8 @@ namespace juce using writeToStream()/readFromStream(), or as JSON by using the JSON class. @see JSON, DynamicObject + + @tags{Core} */ class JUCE_API var { @@ -328,7 +330,10 @@ JUCE_API bool operator== (const var&, const char*); JUCE_API bool operator!= (const var&, const char*); //============================================================================== -/** This template-overloaded class can be used to convert between var and custom types. */ +/** This template-overloaded class can be used to convert between var and custom types. + + @tags{Core} +*/ template struct VariantConverter { @@ -336,12 +341,13 @@ struct VariantConverter static var toVar (const Type& t) { return t; } }; -/** @internal */ +#ifndef DOXYGEN template <> struct VariantConverter { static String fromVar (const var& v) { return v.toString(); } static var toVar (const String& s) { return s; } }; +#endif } // namespace juce diff --git a/modules/juce_core/files/juce_DirectoryIterator.h b/modules/juce_core/files/juce_DirectoryIterator.h index 44cf38fbfc..f8d63e022b 100644 --- a/modules/juce_core/files/juce_DirectoryIterator.h +++ b/modules/juce_core/files/juce_DirectoryIterator.h @@ -40,6 +40,8 @@ namespace juce to manually sort them using your preferred comparator after collecting the list. It also provides an estimate of its progress, using a (highly inaccurate!) algorithm. + + @tags{Core} */ class JUCE_API DirectoryIterator final { diff --git a/modules/juce_core/files/juce_File.h b/modules/juce_core/files/juce_File.h index 8bddde2c83..fd52a39d30 100644 --- a/modules/juce_core/files/juce_File.h +++ b/modules/juce_core/files/juce_File.h @@ -34,6 +34,8 @@ namespace juce output stream. @see FileInputStream, FileOutputStream + + @tags{Core} */ class JUCE_API File final { @@ -1008,6 +1010,7 @@ public: #endif //============================================================================== + /** Comparator for files */ struct NaturalFileComparator { NaturalFileComparator (bool shouldPutFoldersFirst) noexcept : foldersFirst (shouldPutFoldersFirst) {} diff --git a/modules/juce_core/files/juce_FileFilter.h b/modules/juce_core/files/juce_FileFilter.h index e1e241c7f9..c77cb4fb65 100644 --- a/modules/juce_core/files/juce_FileFilter.h +++ b/modules/juce_core/files/juce_FileFilter.h @@ -31,6 +31,8 @@ namespace juce go into the list. @see WildcardFileFilter, DirectoryContentsList, FileListComponent, FileBrowserComponent + + @tags{Core} */ class JUCE_API FileFilter { diff --git a/modules/juce_core/files/juce_FileInputStream.h b/modules/juce_core/files/juce_FileInputStream.h index bf83dd6628..3af822e0ed 100644 --- a/modules/juce_core/files/juce_FileInputStream.h +++ b/modules/juce_core/files/juce_FileInputStream.h @@ -28,6 +28,8 @@ namespace juce An input stream that reads from a local file. @see InputStream, FileOutputStream, File::createInputStream + + @tags{Core} */ class JUCE_API FileInputStream : public InputStream { diff --git a/modules/juce_core/files/juce_FileOutputStream.h b/modules/juce_core/files/juce_FileOutputStream.h index ebe50fe64f..f3729186f8 100644 --- a/modules/juce_core/files/juce_FileOutputStream.h +++ b/modules/juce_core/files/juce_FileOutputStream.h @@ -28,6 +28,8 @@ namespace juce An output stream that writes into a local file. @see OutputStream, FileInputStream, File::createOutputStream + + @tags{Core} */ class JUCE_API FileOutputStream : public OutputStream { diff --git a/modules/juce_core/files/juce_FileSearchPath.h b/modules/juce_core/files/juce_FileSearchPath.h index f0db9305a8..5a8d963f14 100644 --- a/modules/juce_core/files/juce_FileSearchPath.h +++ b/modules/juce_core/files/juce_FileSearchPath.h @@ -28,6 +28,8 @@ namespace juce Represents a set of folders that make up a search path. @see File + + @tags{Core} */ class JUCE_API FileSearchPath { diff --git a/modules/juce_core/files/juce_MemoryMappedFile.h b/modules/juce_core/files/juce_MemoryMappedFile.h index 1edba373e4..d783523fe7 100644 --- a/modules/juce_core/files/juce_MemoryMappedFile.h +++ b/modules/juce_core/files/juce_MemoryMappedFile.h @@ -26,6 +26,8 @@ namespace juce //============================================================================== /** Maps a file into virtual memory for easy reading and/or writing. + + @tags{Core} */ class JUCE_API MemoryMappedFile { diff --git a/modules/juce_core/files/juce_TemporaryFile.h b/modules/juce_core/files/juce_TemporaryFile.h index 831f1a0a34..9813de411e 100644 --- a/modules/juce_core/files/juce_TemporaryFile.h +++ b/modules/juce_core/files/juce_TemporaryFile.h @@ -60,6 +60,8 @@ namespace juce @endcode @see File, FileOutputStream + + @tags{Core} */ class JUCE_API TemporaryFile { diff --git a/modules/juce_core/files/juce_WildcardFileFilter.h b/modules/juce_core/files/juce_WildcardFileFilter.h index b49c498988..e0335fd2fc 100644 --- a/modules/juce_core/files/juce_WildcardFileFilter.h +++ b/modules/juce_core/files/juce_WildcardFileFilter.h @@ -31,6 +31,8 @@ namespace juce allows all directories through. @see FileFilter, DirectoryContentsList, FileListComponent, FileBrowserComponent + + @tags{Core} */ class JUCE_API WildcardFileFilter : public FileFilter { diff --git a/modules/juce_core/javascript/juce_JSON.h b/modules/juce_core/javascript/juce_JSON.h index ed787adfc4..959be2edd6 100644 --- a/modules/juce_core/javascript/juce_JSON.h +++ b/modules/juce_core/javascript/juce_JSON.h @@ -32,6 +32,8 @@ namespace juce object to JSON-formatted text. @see var + + @tags{Core} */ class JUCE_API JSON { diff --git a/modules/juce_core/javascript/juce_Javascript.h b/modules/juce_core/javascript/juce_Javascript.h index 5d45df800f..dd8fb6a942 100644 --- a/modules/juce_core/javascript/juce_Javascript.h +++ b/modules/juce_core/javascript/juce_Javascript.h @@ -41,6 +41,8 @@ namespace juce and var objects, they use reference-counting rather than garbage-collection, so if your script creates complex connections between objects, you run the risk of creating cyclic dependencies and hence leaking. + + @tags{Core} */ class JUCE_API JavascriptEngine final { diff --git a/modules/juce_core/logging/juce_FileLogger.h b/modules/juce_core/logging/juce_FileLogger.h index ac29683ca8..ff932a91ce 100644 --- a/modules/juce_core/logging/juce_FileLogger.h +++ b/modules/juce_core/logging/juce_FileLogger.h @@ -28,6 +28,8 @@ namespace juce A simple implementation of a Logger that writes to a file. @see Logger + + @tags{Core} */ class JUCE_API FileLogger : public Logger { diff --git a/modules/juce_core/logging/juce_Logger.h b/modules/juce_core/logging/juce_Logger.h index bb38c565bd..60218a3baa 100644 --- a/modules/juce_core/logging/juce_Logger.h +++ b/modules/juce_core/logging/juce_Logger.h @@ -34,6 +34,8 @@ namespace juce output stream. @see FileLogger + + @tags{Core} */ class JUCE_API Logger { diff --git a/modules/juce_core/maths/juce_BigInteger.h b/modules/juce_core/maths/juce_BigInteger.h index 46b417e7e2..3463f3cfdf 100644 --- a/modules/juce_core/maths/juce_BigInteger.h +++ b/modules/juce_core/maths/juce_BigInteger.h @@ -32,6 +32,8 @@ namespace juce Negative values are possible, but the value isn't stored as 2s-complement, so be careful if you use negative values and look at the values of individual bits. + + @tags{Core} */ class JUCE_API BigInteger { diff --git a/modules/juce_core/maths/juce_Expression.h b/modules/juce_core/maths/juce_Expression.h index a3a4af7a4e..09ef93b734 100644 --- a/modules/juce_core/maths/juce_Expression.h +++ b/modules/juce_core/maths/juce_Expression.h @@ -37,6 +37,8 @@ namespace juce Expression::Scope to be supplied when evaluating them, and this object is expected to be able to resolve the symbol names and perform the functions that are used. + + @tags{Core} */ class JUCE_API Expression { diff --git a/modules/juce_core/maths/juce_MathsFunctions.h b/modules/juce_core/maths/juce_MathsFunctions.h index 43d6ee25ba..01962e1211 100644 --- a/modules/juce_core/maths/juce_MathsFunctions.h +++ b/modules/juce_core/maths/juce_MathsFunctions.h @@ -322,7 +322,10 @@ inline float juce_hypot (float a, float b) noexcept //============================================================================== #if JUCE_HAS_CONSTEXPR -/** Commonly used mathematical constants */ +/** Commonly used mathematical constants + + @tags{Core} +*/ template struct MathConstants { @@ -344,7 +347,10 @@ struct MathConstants #else -/** Commonly used mathematical constants */ +/** Commonly used mathematical constants + + @tags{Core} +*/ template struct MathConstants { @@ -618,6 +624,8 @@ namespace TypeHelpers E.g. "myFunction (typename TypeHelpers::ParameterType::type, typename TypeHelpers::ParameterType::type)" would evaluate to "myfunction (int, const MyObject&)", keeping any primitive types as pass-by-value, but passing objects as a const reference, to avoid copying. + + @tags{Core} */ template struct ParameterType { typedef const Type& type; }; @@ -641,6 +649,8 @@ namespace TypeHelpers /** These templates are designed to take a type, and if it's a double, they return a double type; for anything else, they return a float type. + + @tags{Core} */ template struct SmallestFloatType { typedef float type; }; @@ -650,6 +660,8 @@ namespace TypeHelpers /** These templates are designed to take an integer type, and return an unsigned int version with the same size. + + @tags{Core} */ template struct UnsignedTypeWithSize {}; diff --git a/modules/juce_core/maths/juce_NormalisableRange.h b/modules/juce_core/maths/juce_NormalisableRange.h index 27d26d5585..4ba72f4db5 100644 --- a/modules/juce_core/maths/juce_NormalisableRange.h +++ b/modules/juce_core/maths/juce_NormalisableRange.h @@ -32,6 +32,8 @@ namespace juce and skew-factor. @see Range + + @tags{Core} */ template class NormalisableRange diff --git a/modules/juce_core/maths/juce_Random.h b/modules/juce_core/maths/juce_Random.h index 696a079e06..06fc278a43 100644 --- a/modules/juce_core/maths/juce_Random.h +++ b/modules/juce_core/maths/juce_Random.h @@ -28,6 +28,8 @@ namespace juce A random number generator. You can create a Random object and use it to generate a sequence of random numbers. + + @tags{Core} */ class JUCE_API Random final { diff --git a/modules/juce_core/maths/juce_Range.h b/modules/juce_core/maths/juce_Range.h index bbdfa765f6..f534a53aff 100644 --- a/modules/juce_core/maths/juce_Range.h +++ b/modules/juce_core/maths/juce_Range.h @@ -32,6 +32,8 @@ namespace juce The templated parameter is expected to be a primitive integer or floating point type, though class types could also be used if they behave in a number-like way. + + @tags{Core} */ template class Range diff --git a/modules/juce_core/maths/juce_StatisticsAccumulator.h b/modules/juce_core/maths/juce_StatisticsAccumulator.h index 4d1b61f4ba..3e00bce4fa 100644 --- a/modules/juce_core/maths/juce_StatisticsAccumulator.h +++ b/modules/juce_core/maths/juce_StatisticsAccumulator.h @@ -27,6 +27,8 @@ namespace juce /** A class that measures various statistics about a series of floating point values that it is given. + + @tags{Core} */ template class StatisticsAccumulator diff --git a/modules/juce_core/memory/juce_Atomic.h b/modules/juce_core/memory/juce_Atomic.h index 9fbfecf6b9..9e9a7ec1b0 100644 --- a/modules/juce_core/memory/juce_Atomic.h +++ b/modules/juce_core/memory/juce_Atomic.h @@ -35,6 +35,8 @@ namespace juce //============================================================================== /** A simple wrapper around std::atomic. + + @tags{Core} */ template struct Atomic final @@ -152,8 +154,9 @@ namespace juce #define JUCE_64BIT_ATOMICS_UNAVAILABLE 1 #endif - /** @internal */ - template class AtomicBase; + #ifndef DOXYGEN + template class AtomicBase; + #endif //============================================================================== /** @@ -161,6 +164,8 @@ namespace juce The type used must be a 32 or 64 bit primitive, like an int, pointer, etc. There are methods to perform most of the basic atomic operations. + + @tags{Core} */ template class Atomic final : public AtomicBase diff --git a/modules/juce_core/memory/juce_ByteOrder.h b/modules/juce_core/memory/juce_ByteOrder.h index ed7cdefe11..2d11572cc0 100644 --- a/modules/juce_core/memory/juce_ByteOrder.h +++ b/modules/juce_core/memory/juce_ByteOrder.h @@ -26,6 +26,8 @@ namespace juce //============================================================================== /** Contains static methods for converting the byte order between different endiannesses. + + @tags{Core} */ class JUCE_API ByteOrder { diff --git a/modules/juce_core/memory/juce_ContainerDeletePolicy.h b/modules/juce_core/memory/juce_ContainerDeletePolicy.h index 26d1497382..bd3fd39ce1 100644 --- a/modules/juce_core/memory/juce_ContainerDeletePolicy.h +++ b/modules/juce_core/memory/juce_ContainerDeletePolicy.h @@ -33,6 +33,8 @@ namespace juce delete that type of object in a more appropriate way. @see ScopedPointer, OwnedArray + + @tags{Core} */ template struct ContainerDeletePolicy diff --git a/modules/juce_core/memory/juce_HeapBlock.h b/modules/juce_core/memory/juce_HeapBlock.h index 241cf759d0..24e6746a2e 100644 --- a/modules/juce_core/memory/juce_HeapBlock.h +++ b/modules/juce_core/memory/juce_HeapBlock.h @@ -79,6 +79,8 @@ namespace HeapBlockHelper that the system's malloc() function doesn't throw). @see Array, OwnedArray, MemoryBlock + + @tags{Core} */ template class HeapBlock diff --git a/modules/juce_core/memory/juce_LeakedObjectDetector.h b/modules/juce_core/memory/juce_LeakedObjectDetector.h index d48be309eb..a1e9368b16 100644 --- a/modules/juce_core/memory/juce_LeakedObjectDetector.h +++ b/modules/juce_core/memory/juce_LeakedObjectDetector.h @@ -35,6 +35,8 @@ namespace juce To use it, use the JUCE_LEAK_DETECTOR macro as a simple way to put one in your class declaration. Have a look through the juce codebase for examples, it's used in most of the classes. + + @tags{Core} */ template class LeakedObjectDetector diff --git a/modules/juce_core/memory/juce_Memory.h b/modules/juce_core/memory/juce_Memory.h index 83b81117a9..c2be191f2d 100644 --- a/modules/juce_core/memory/juce_Memory.h +++ b/modules/juce_core/memory/juce_Memory.h @@ -88,6 +88,8 @@ inline void writeUnaligned (void* dstPtr, Type value) noexcept /** A handy C++ wrapper that creates and deletes an NSAutoreleasePool object using RAII. You should use the JUCE_AUTORELEASEPOOL macro to create a local auto-release pool on the stack. + + @tags{Core} */ class JUCE_API ScopedAutoReleasePool { diff --git a/modules/juce_core/memory/juce_MemoryBlock.h b/modules/juce_core/memory/juce_MemoryBlock.h index d842244305..a245c8a003 100644 --- a/modules/juce_core/memory/juce_MemoryBlock.h +++ b/modules/juce_core/memory/juce_MemoryBlock.h @@ -27,6 +27,8 @@ namespace juce /** A class to hold a resizable block of raw data. + + @tags{Core} */ class JUCE_API MemoryBlock { diff --git a/modules/juce_core/memory/juce_OptionalScopedPointer.h b/modules/juce_core/memory/juce_OptionalScopedPointer.h index 2417b7aa4e..dd6e7e3245 100644 --- a/modules/juce_core/memory/juce_OptionalScopedPointer.h +++ b/modules/juce_core/memory/juce_OptionalScopedPointer.h @@ -32,6 +32,8 @@ namespace juce not the object is deleted. @see ScopedPointer + + @tags{Core} */ template class OptionalScopedPointer diff --git a/modules/juce_core/memory/juce_ReferenceCountedObject.h b/modules/juce_core/memory/juce_ReferenceCountedObject.h index edc4555644..37986db994 100644 --- a/modules/juce_core/memory/juce_ReferenceCountedObject.h +++ b/modules/juce_core/memory/juce_ReferenceCountedObject.h @@ -54,6 +54,8 @@ namespace juce version, use SingleThreadedReferenceCountedObject instead. @see ReferenceCountedObjectPtr, ReferenceCountedArray, SingleThreadedReferenceCountedObject + + @tags{Core} */ class JUCE_API ReferenceCountedObject { @@ -140,6 +142,8 @@ private: For more details on how to use it, see the ReferenceCountedObject class notes. @see ReferenceCountedObject, ReferenceCountedObjectPtr, ReferenceCountedArray + + @tags{Core} */ class JUCE_API SingleThreadedReferenceCountedObject { @@ -230,6 +234,8 @@ private: @endcode @see ReferenceCountedObject, ReferenceCountedObjectArray + + @tags{Core} */ template class ReferenceCountedObjectPtr diff --git a/modules/juce_core/memory/juce_ScopedPointer.h b/modules/juce_core/memory/juce_ScopedPointer.h index 9b2dc40aef..35de13397b 100644 --- a/modules/juce_core/memory/juce_ScopedPointer.h +++ b/modules/juce_core/memory/juce_ScopedPointer.h @@ -59,6 +59,8 @@ namespace juce ScopedPointer contains an overloaded constructor that should cause a syntax error in these circumstances, but it does mean that instead of returning a ScopedPointer from a function, you'd need to return a raw pointer (or use a std::auto_ptr instead). + + @tags{Core} */ template class ScopedPointer diff --git a/modules/juce_core/memory/juce_SharedResourcePointer.h b/modules/juce_core/memory/juce_SharedResourcePointer.h index 89de47a64b..cb9d2fc55c 100644 --- a/modules/juce_core/memory/juce_SharedResourcePointer.h +++ b/modules/juce_core/memory/juce_SharedResourcePointer.h @@ -74,7 +74,9 @@ namespace juce }; @endcode - */ + + @tags{Core} +*/ template class SharedResourcePointer { diff --git a/modules/juce_core/memory/juce_Singleton.h b/modules/juce_core/memory/juce_Singleton.h index 1136197308..2ed9ea5db1 100644 --- a/modules/juce_core/memory/juce_Singleton.h +++ b/modules/juce_core/memory/juce_Singleton.h @@ -31,6 +31,8 @@ namespace juce You generally won't use this directly, but see the macros JUCE_DECLARE_SINGLETON, JUCE_DECLARE_SINGLETON_SINGLETHREADED, JUCE_DECLARE_SINGLETON_SINGLETHREADED_MINIMAL, and JUCE_IMPLEMENT_SINGLETON for how it is intended to be used. + + @tags{Core} */ template struct SingletonHolder : private MutexType // (inherited so we can use the empty-base-class optimisation) diff --git a/modules/juce_core/memory/juce_WeakReference.h b/modules/juce_core/memory/juce_WeakReference.h index 88110622bb..0c89af8483 100644 --- a/modules/juce_core/memory/juce_WeakReference.h +++ b/modules/juce_core/memory/juce_WeakReference.h @@ -72,6 +72,8 @@ namespace juce @endcode @see WeakReference::Master + + @tags{Core} */ template class WeakReference diff --git a/modules/juce_core/misc/juce_Result.h b/modules/juce_core/misc/juce_Result.h index 5f08bfc4d6..5836b4e075 100644 --- a/modules/juce_core/misc/juce_Result.h +++ b/modules/juce_core/misc/juce_Result.h @@ -50,6 +50,8 @@ namespace juce + result.getErrorMessage()); } @endcode + + @tags{Core} */ class JUCE_API Result { diff --git a/modules/juce_core/misc/juce_RuntimePermissions.h b/modules/juce_core/misc/juce_RuntimePermissions.h index 4de84c678f..43200ebea8 100644 --- a/modules/juce_core/misc/juce_RuntimePermissions.h +++ b/modules/juce_core/misc/juce_RuntimePermissions.h @@ -58,6 +58,8 @@ namespace juce audioDeviceManager.initialise (2, 2, nullptr, true, String(), nullptr); } ); + + @tags{Core} */ class JUCE_API RuntimePermissions { diff --git a/modules/juce_core/misc/juce_StdFunctionCompat.h b/modules/juce_core/misc/juce_StdFunctionCompat.h index 322247e8a9..cccdaae93f 100644 --- a/modules/juce_core/misc/juce_StdFunctionCompat.h +++ b/modules/juce_core/misc/juce_StdFunctionCompat.h @@ -34,11 +34,13 @@ namespace std This class provides an alternative to std::function that is compatible with OS X 10.6 and earlier. This will only be used in OS X versions 10.6 and earlier and the Projucer live build. - */ + @tags{Core} + */ template class function; + #ifndef DOXYGEN template class function { @@ -204,4 +206,5 @@ namespace std FunctorHolderBase* functorHolderHelper = nullptr; }; + #endif } diff --git a/modules/juce_core/misc/juce_Uuid.h b/modules/juce_core/misc/juce_Uuid.h index 5eee6d67cc..08bb4da94e 100644 --- a/modules/juce_core/misc/juce_Uuid.h +++ b/modules/juce_core/misc/juce_Uuid.h @@ -32,6 +32,8 @@ namespace juce formatted to meet the RFC 4122 version 4 standard. The class includes methods for saving the ID as a string or as raw binary data. + + @tags{Core} */ class JUCE_API Uuid { diff --git a/modules/juce_core/misc/juce_WindowsRegistry.h b/modules/juce_core/misc/juce_WindowsRegistry.h index 683f6f6ca4..e1d076130f 100644 --- a/modules/juce_core/misc/juce_WindowsRegistry.h +++ b/modules/juce_core/misc/juce_WindowsRegistry.h @@ -28,6 +28,8 @@ namespace juce /** Contains some static helper functions for manipulating the MS Windows registry (Only available on Windows, of course!) + + @tags{Core} */ class JUCE_API WindowsRegistry { diff --git a/modules/juce_core/native/juce_win32_ComSmartPtr.h b/modules/juce_core/native/juce_win32_ComSmartPtr.h index 0a6511c4c8..29b455d2cb 100644 --- a/modules/juce_core/native/juce_win32_ComSmartPtr.h +++ b/modules/juce_core/native/juce_win32_ComSmartPtr.h @@ -78,6 +78,8 @@ inline GUID uuidFromString (const char* s) noexcept //============================================================================== /** A simple COM smart pointer. + + @tags{Core} */ template class ComSmartPtr @@ -174,6 +176,8 @@ protected: }; /** Handy base class for writing COM objects, providing ref-counting and a basic QueryInterface method. + + @tags{Core} */ template class ComBaseClassHelper : public ComBaseClassHelperBase diff --git a/modules/juce_core/network/juce_IPAddress.h b/modules/juce_core/network/juce_IPAddress.h index cfb7568afa..49ecfde45e 100644 --- a/modules/juce_core/network/juce_IPAddress.h +++ b/modules/juce_core/network/juce_IPAddress.h @@ -26,6 +26,8 @@ namespace juce //============================================================================== /** Represents an IP address. + + @tags{Core} */ class JUCE_API IPAddress final { diff --git a/modules/juce_core/network/juce_MACAddress.h b/modules/juce_core/network/juce_MACAddress.h index 29ccccb8d2..ae0661ebc3 100644 --- a/modules/juce_core/network/juce_MACAddress.h +++ b/modules/juce_core/network/juce_MACAddress.h @@ -26,6 +26,8 @@ namespace juce //============================================================================== /** Represents a MAC network card adapter address ID. + + @tags{Core} */ class JUCE_API MACAddress final { diff --git a/modules/juce_core/network/juce_NamedPipe.h b/modules/juce_core/network/juce_NamedPipe.h index 3e61bdf7ae..9dbd768059 100644 --- a/modules/juce_core/network/juce_NamedPipe.h +++ b/modules/juce_core/network/juce_NamedPipe.h @@ -30,6 +30,8 @@ namespace juce Two processes can use NamedPipe objects to exchange blocks of data. @see InterprocessConnection + + @tags{Core} */ class JUCE_API NamedPipe final { diff --git a/modules/juce_core/network/juce_Socket.h b/modules/juce_core/network/juce_Socket.h index fe689b4fe8..3ef49d3731 100644 --- a/modules/juce_core/network/juce_Socket.h +++ b/modules/juce_core/network/juce_Socket.h @@ -31,6 +31,8 @@ namespace juce sockets, you could also try the InterprocessConnection class. @see DatagramSocket, InterprocessConnection, InterprocessConnectionServer + + @tags{Core} */ class JUCE_API StreamingSocket final { @@ -193,6 +195,8 @@ private: sockets, you could also try the InterprocessConnection class. @see StreamingSocket, InterprocessConnection, InterprocessConnectionServer + + @tags{Core} */ class JUCE_API DatagramSocket final { diff --git a/modules/juce_core/network/juce_URL.h b/modules/juce_core/network/juce_URL.h index 4ac1b856b1..0a8c64b428 100644 --- a/modules/juce_core/network/juce_URL.h +++ b/modules/juce_core/network/juce_URL.h @@ -31,6 +31,8 @@ class WebInputStream; This class can be used to launch URLs in browsers, and also to create InputStreams that can read from remote http or ftp sources. + + @tags{Core} */ class JUCE_API URL { @@ -350,6 +352,7 @@ public: class DownloadTask { public: + /** Used to receive callbacks for download progress */ struct Listener { virtual ~Listener(); diff --git a/modules/juce_core/network/juce_WebInputStream.h b/modules/juce_core/network/juce_WebInputStream.h index d09e004395..c9baaf5cd9 100644 --- a/modules/juce_core/network/juce_WebInputStream.h +++ b/modules/juce_core/network/juce_WebInputStream.h @@ -26,10 +26,13 @@ namespace juce //============================================================================== /** An InputStream which can be used to read from a given url. + + @tags{Core} */ class JUCE_API WebInputStream : public InputStream { public: + /** Used to receive callbacks for data send progress */ class JUCE_API Listener { public: diff --git a/modules/juce_core/streams/juce_BufferedInputStream.h b/modules/juce_core/streams/juce_BufferedInputStream.h index 8a5da9ab2d..acdb2bc877 100644 --- a/modules/juce_core/streams/juce_BufferedInputStream.h +++ b/modules/juce_core/streams/juce_BufferedInputStream.h @@ -30,6 +30,8 @@ namespace juce small read accesses to it, it's probably sensible to wrap it in one of these, so that the source stream gets accessed in larger chunk sizes, meaning less work for the underlying stream. + + @tags{Core} */ class JUCE_API BufferedInputStream : public InputStream { diff --git a/modules/juce_core/streams/juce_FileInputSource.h b/modules/juce_core/streams/juce_FileInputSource.h index d5f5942132..84b918512e 100644 --- a/modules/juce_core/streams/juce_FileInputSource.h +++ b/modules/juce_core/streams/juce_FileInputSource.h @@ -28,6 +28,8 @@ namespace juce A type of InputSource that represents a normal file. @see InputSource + + @tags{Core} */ class JUCE_API FileInputSource : public InputSource { diff --git a/modules/juce_core/streams/juce_InputSource.h b/modules/juce_core/streams/juce_InputSource.h index 925cdf30f6..57f974f19f 100644 --- a/modules/juce_core/streams/juce_InputSource.h +++ b/modules/juce_core/streams/juce_InputSource.h @@ -31,6 +31,8 @@ namespace juce caller to create an input stream that can read from it when required. @see FileInputSource + + @tags{Core} */ class JUCE_API InputSource { diff --git a/modules/juce_core/streams/juce_InputStream.h b/modules/juce_core/streams/juce_InputStream.h index 398615ad85..972047c6ef 100644 --- a/modules/juce_core/streams/juce_InputStream.h +++ b/modules/juce_core/streams/juce_InputStream.h @@ -30,6 +30,8 @@ namespace juce some or all of the virtual functions to implement their behaviour. @see OutputStream, MemoryInputStream, BufferedInputStream, FileInputStream + + @tags{Core} */ class JUCE_API InputStream { diff --git a/modules/juce_core/streams/juce_MemoryInputStream.h b/modules/juce_core/streams/juce_MemoryInputStream.h index 8b84816660..64ba2e3c7d 100644 --- a/modules/juce_core/streams/juce_MemoryInputStream.h +++ b/modules/juce_core/streams/juce_MemoryInputStream.h @@ -29,6 +29,8 @@ namespace juce This can either be used to refer to a shared block of memory, or can make its own internal copy of the data when the MemoryInputStream is created. + + @tags{Core} */ class JUCE_API MemoryInputStream : public InputStream { diff --git a/modules/juce_core/streams/juce_MemoryOutputStream.h b/modules/juce_core/streams/juce_MemoryOutputStream.h index 56d4620b08..047964f5bd 100644 --- a/modules/juce_core/streams/juce_MemoryOutputStream.h +++ b/modules/juce_core/streams/juce_MemoryOutputStream.h @@ -29,6 +29,8 @@ namespace juce The data that was written into the stream can then be accessed later as a contiguous block of memory. + + @tags{Core} */ class JUCE_API MemoryOutputStream : public OutputStream { diff --git a/modules/juce_core/streams/juce_OutputStream.h b/modules/juce_core/streams/juce_OutputStream.h index 1ab0a0ce77..11f3d16a81 100644 --- a/modules/juce_core/streams/juce_OutputStream.h +++ b/modules/juce_core/streams/juce_OutputStream.h @@ -31,6 +31,8 @@ namespace juce some or all of the virtual functions to implement their behaviour. @see InputStream, MemoryOutputStream, FileOutputStream + + @tags{Core} */ class JUCE_API OutputStream { diff --git a/modules/juce_core/streams/juce_SubregionStream.h b/modules/juce_core/streams/juce_SubregionStream.h index 998a2ccdb1..1c4ead3353 100644 --- a/modules/juce_core/streams/juce_SubregionStream.h +++ b/modules/juce_core/streams/juce_SubregionStream.h @@ -28,6 +28,8 @@ namespace juce This lets you take a subsection of a stream and present it as an entire stream in its own right. + + @tags{Core} */ class JUCE_API SubregionStream : public InputStream { diff --git a/modules/juce_core/system/juce_SystemStats.h b/modules/juce_core/system/juce_SystemStats.h index 041807a518..f804a62c01 100644 --- a/modules/juce_core/system/juce_SystemStats.h +++ b/modules/juce_core/system/juce_SystemStats.h @@ -26,6 +26,8 @@ namespace juce //============================================================================== /** Contains methods for finding out about the current hardware and OS configuration. + + @tags{Core} */ class JUCE_API SystemStats final { diff --git a/modules/juce_core/text/juce_Base64.h b/modules/juce_core/text/juce_Base64.h index c7eafa2212..6e59a19e4d 100644 --- a/modules/juce_core/text/juce_Base64.h +++ b/modules/juce_core/text/juce_Base64.h @@ -26,6 +26,8 @@ namespace juce /** Contains some static methods for converting between binary and the standard base-64 encoding format. + + @tags{Core} */ struct JUCE_API Base64 { diff --git a/modules/juce_core/text/juce_CharPointer_ASCII.h b/modules/juce_core/text/juce_CharPointer_ASCII.h index 83ce529964..6dd1c36849 100644 --- a/modules/juce_core/text/juce_CharPointer_ASCII.h +++ b/modules/juce_core/text/juce_CharPointer_ASCII.h @@ -31,6 +31,8 @@ namespace juce A valid ASCII string is assumed to not contain any characters above 127. @see CharPointer_UTF8, CharPointer_UTF16, CharPointer_UTF32 + + @tags{Core} */ class CharPointer_ASCII final { diff --git a/modules/juce_core/text/juce_CharPointer_UTF16.h b/modules/juce_core/text/juce_CharPointer_UTF16.h index 1f3caf510e..0bff3f3570 100644 --- a/modules/juce_core/text/juce_CharPointer_UTF16.h +++ b/modules/juce_core/text/juce_CharPointer_UTF16.h @@ -28,6 +28,8 @@ namespace juce Wraps a pointer to a null-terminated UTF-16 character string, and provides various methods to operate on the data. @see CharPointer_UTF8, CharPointer_UTF32 + + @tags{Core} */ class CharPointer_UTF16 final { diff --git a/modules/juce_core/text/juce_CharPointer_UTF32.h b/modules/juce_core/text/juce_CharPointer_UTF32.h index 1786d8842b..e842389491 100644 --- a/modules/juce_core/text/juce_CharPointer_UTF32.h +++ b/modules/juce_core/text/juce_CharPointer_UTF32.h @@ -28,6 +28,8 @@ namespace juce Wraps a pointer to a null-terminated UTF-32 character string, and provides various methods to operate on the data. @see CharPointer_UTF8, CharPointer_UTF16 + + @tags{Core} */ class CharPointer_UTF32 final { diff --git a/modules/juce_core/text/juce_CharPointer_UTF8.h b/modules/juce_core/text/juce_CharPointer_UTF8.h index 071d1737a7..09bda467df 100644 --- a/modules/juce_core/text/juce_CharPointer_UTF8.h +++ b/modules/juce_core/text/juce_CharPointer_UTF8.h @@ -28,6 +28,8 @@ namespace juce Wraps a pointer to a null-terminated UTF-8 character string, and provides various methods to operate on the data. @see CharPointer_UTF16, CharPointer_UTF32 + + @tags{Core} */ class CharPointer_UTF8 final { diff --git a/modules/juce_core/text/juce_CharacterFunctions.h b/modules/juce_core/text/juce_CharacterFunctions.h index e2c3dc5ad7..e5681ec150 100644 --- a/modules/juce_core/text/juce_CharacterFunctions.h +++ b/modules/juce_core/text/juce_CharacterFunctions.h @@ -85,6 +85,8 @@ namespace internal classes, but some of them may be useful to call directly. @see String, CharPointer_UTF8, CharPointer_UTF16, CharPointer_UTF32 + + @tags{Core} */ class JUCE_API CharacterFunctions { @@ -403,6 +405,7 @@ public: return isNeg ? - (IntType) v : (IntType) v; } + /** Parses a character string, to read a hexadecimal value. */ template struct HexParser { diff --git a/modules/juce_core/text/juce_Identifier.h b/modules/juce_core/text/juce_Identifier.h index fc08a7be1f..f606e40ddf 100644 --- a/modules/juce_core/text/juce_Identifier.h +++ b/modules/juce_core/text/juce_Identifier.h @@ -32,6 +32,8 @@ namespace juce is to keep some static Identifier objects for the things you use often. @see NamedValueSet, ValueTree + + @tags{Core} */ class JUCE_API Identifier final { diff --git a/modules/juce_core/text/juce_LocalisedStrings.h b/modules/juce_core/text/juce_LocalisedStrings.h index 7ecca31798..87501f9b35 100644 --- a/modules/juce_core/text/juce_LocalisedStrings.h +++ b/modules/juce_core/text/juce_LocalisedStrings.h @@ -65,6 +65,8 @@ namespace juce intercept and translate any internal JUCE text strings that might be shown. (You can easily get a list of all the messages by searching for the TRANS() macro in the JUCE source code). + + @tags{Core} */ class JUCE_API LocalisedStrings { diff --git a/modules/juce_core/text/juce_NewLine.h b/modules/juce_core/text/juce_NewLine.h index 164f4b1c3f..121e70aa03 100644 --- a/modules/juce_core/text/juce_NewLine.h +++ b/modules/juce_core/text/juce_NewLine.h @@ -33,6 +33,8 @@ namespace juce The exact character sequence that will be used for the new-line can be set and retrieved with OutputStream::setNewLineString() and OutputStream::getNewLineString(). + + @tags{Core} */ class JUCE_API NewLine { diff --git a/modules/juce_core/text/juce_String.h b/modules/juce_core/text/juce_String.h index 1cd82f35bb..1a8c03e846 100644 --- a/modules/juce_core/text/juce_String.h +++ b/modules/juce_core/text/juce_String.h @@ -32,6 +32,8 @@ namespace juce dream of. @see StringArray, StringPairArray + + @tags{Core} */ class JUCE_API String final { @@ -1415,7 +1417,7 @@ JUCE_API OutputStream& JUCE_CALLTYPE operator<< (OutputStream& stream, StringRef } // namespace juce -#if JUCE_COMPILER_SUPPORTS_INITIALIZER_LISTS // just used to avoid compiling this under compilers that lack libc++ +#if JUCE_COMPILER_SUPPORTS_INITIALIZER_LISTS && ! DOXYGEN // just used to avoid compiling this under compilers that lack libc++ namespace std { template <> struct hash diff --git a/modules/juce_core/text/juce_StringArray.h b/modules/juce_core/text/juce_StringArray.h index d6dbf3c5fd..b45fd5c0f5 100644 --- a/modules/juce_core/text/juce_StringArray.h +++ b/modules/juce_core/text/juce_StringArray.h @@ -28,6 +28,8 @@ namespace juce A special array for holding a list of strings. @see String, StringPairArray + + @tags{Core} */ class JUCE_API StringArray { diff --git a/modules/juce_core/text/juce_StringPairArray.h b/modules/juce_core/text/juce_StringPairArray.h index 8bf8b61543..1d8fb3a4fa 100644 --- a/modules/juce_core/text/juce_StringPairArray.h +++ b/modules/juce_core/text/juce_StringPairArray.h @@ -28,6 +28,8 @@ namespace juce A container for holding a set of strings which are keyed by another string. @see StringArray + + @tags{Core} */ class JUCE_API StringPairArray { diff --git a/modules/juce_core/text/juce_StringPool.h b/modules/juce_core/text/juce_StringPool.h index 0f81bbbca3..e6d181f3ee 100644 --- a/modules/juce_core/text/juce_StringPool.h +++ b/modules/juce_core/text/juce_StringPool.h @@ -33,6 +33,8 @@ namespace juce is returned every time a matching string is asked for. This means that it's trivial to compare two pooled strings for equality, as you can simply compare their pointers. It also cuts down on storage if you're using many copies of the same string. + + @tags{Core} */ class JUCE_API StringPool { diff --git a/modules/juce_core/text/juce_StringRef.h b/modules/juce_core/text/juce_StringRef.h index 2e21fec575..2c171f4614 100644 --- a/modules/juce_core/text/juce_StringRef.h +++ b/modules/juce_core/text/juce_StringRef.h @@ -55,6 +55,8 @@ namespace juce argument to already be a String. @see String + + @tags{Core} */ class JUCE_API StringRef final { diff --git a/modules/juce_core/text/juce_TextDiff.h b/modules/juce_core/text/juce_TextDiff.h index 05910ff0cd..cf5cbb4ac0 100644 --- a/modules/juce_core/text/juce_TextDiff.h +++ b/modules/juce_core/text/juce_TextDiff.h @@ -30,6 +30,8 @@ namespace juce Once created, the TextDiff object contains an array of change objects, where each change can be either an insertion or a deletion. When applied in order to the original string, these changes will convert it to the target string. + + @tags{Core} */ class JUCE_API TextDiff { diff --git a/modules/juce_core/threads/juce_ChildProcess.h b/modules/juce_core/threads/juce_ChildProcess.h index 98250f3613..61e7683c67 100644 --- a/modules/juce_core/threads/juce_ChildProcess.h +++ b/modules/juce_core/threads/juce_ChildProcess.h @@ -29,6 +29,8 @@ namespace juce This class lets you launch an executable, and read its output. You can also use it to check whether the child process has finished. + + @tags{Core} */ class JUCE_API ChildProcess { diff --git a/modules/juce_core/threads/juce_CriticalSection.h b/modules/juce_core/threads/juce_CriticalSection.h index b382acdc75..70b75304eb 100644 --- a/modules/juce_core/threads/juce_CriticalSection.h +++ b/modules/juce_core/threads/juce_CriticalSection.h @@ -36,6 +36,8 @@ namespace juce C++ static object order-of-construction warnings should be heeded. @see ScopedLock, ScopedTryLock, ScopedUnlock, SpinLock, ReadWriteLock, Thread, InterProcessLock + + @tags{Core} */ class JUCE_API CriticalSection { @@ -125,6 +127,8 @@ private: manage to optimise it out of existence. @see CriticalSection, Array, OwnedArray, ReferenceCountedArray + + @tags{Core} */ class JUCE_API DummyCriticalSection { diff --git a/modules/juce_core/threads/juce_DynamicLibrary.h b/modules/juce_core/threads/juce_DynamicLibrary.h index a4a273769b..0ad5198d2e 100644 --- a/modules/juce_core/threads/juce_DynamicLibrary.h +++ b/modules/juce_core/threads/juce_DynamicLibrary.h @@ -29,6 +29,8 @@ namespace juce This class can be used to open a DLL and get some function pointers from it. Since the DLL is freed when this object is deleted, it's handy for managing library lifetimes using RAII. + + @tags{Core} */ class JUCE_API DynamicLibrary { diff --git a/modules/juce_core/threads/juce_HighResolutionTimer.h b/modules/juce_core/threads/juce_HighResolutionTimer.h index 4c846093cb..b771e66d5a 100644 --- a/modules/juce_core/threads/juce_HighResolutionTimer.h +++ b/modules/juce_core/threads/juce_HighResolutionTimer.h @@ -36,6 +36,8 @@ namespace juce starting/stopping it may involve launching and killing threads. @see Timer + + @tags{Core} */ class JUCE_API HighResolutionTimer { diff --git a/modules/juce_core/threads/juce_InterProcessLock.h b/modules/juce_core/threads/juce_InterProcessLock.h index 3bec0275d7..14db4a69a0 100644 --- a/modules/juce_core/threads/juce_InterProcessLock.h +++ b/modules/juce_core/threads/juce_InterProcessLock.h @@ -28,6 +28,8 @@ namespace juce Acts as a critical section which processes can use to block each other. @see CriticalSection + + @tags{Core} */ class JUCE_API InterProcessLock { diff --git a/modules/juce_core/threads/juce_Process.h b/modules/juce_core/threads/juce_Process.h index 99d4ba0716..726fa19384 100644 --- a/modules/juce_core/threads/juce_Process.h +++ b/modules/juce_core/threads/juce_Process.h @@ -30,6 +30,8 @@ namespace juce process-level. @see Thread, JUCEApplicationBase + + @tags{Core} */ class JUCE_API Process { diff --git a/modules/juce_core/threads/juce_ReadWriteLock.h b/modules/juce_core/threads/juce_ReadWriteLock.h index 4d3f6e5172..7bb2eeea0c 100644 --- a/modules/juce_core/threads/juce_ReadWriteLock.h +++ b/modules/juce_core/threads/juce_ReadWriteLock.h @@ -41,6 +41,8 @@ namespace juce - Recursive locking is supported. @see ScopedReadLock, ScopedWriteLock, CriticalSection + + @tags{Core} */ class JUCE_API ReadWriteLock { diff --git a/modules/juce_core/threads/juce_ScopedLock.h b/modules/juce_core/threads/juce_ScopedLock.h index 3239fed9f3..aeac94d769 100644 --- a/modules/juce_core/threads/juce_ScopedLock.h +++ b/modules/juce_core/threads/juce_ScopedLock.h @@ -47,6 +47,8 @@ namespace juce @endcode @see GenericScopedUnlock, CriticalSection, SpinLock, ScopedLock, ScopedUnlock + + @tags{Core} */ template class GenericScopedLock @@ -116,6 +118,8 @@ private: @endcode @see GenericScopedLock, CriticalSection, ScopedLock, ScopedUnlock + + @tags{Core} */ template class GenericScopedUnlock @@ -186,6 +190,8 @@ private: @endcode @see CriticalSection::tryEnter, GenericScopedLock, GenericScopedUnlock + + @tags{Core} */ template class GenericScopedTryLock diff --git a/modules/juce_core/threads/juce_ScopedReadLock.h b/modules/juce_core/threads/juce_ScopedReadLock.h index fa5fe1ab04..b12afd3302 100644 --- a/modules/juce_core/threads/juce_ScopedReadLock.h +++ b/modules/juce_core/threads/juce_ScopedReadLock.h @@ -45,6 +45,8 @@ namespace juce @endcode @see ReadWriteLock, ScopedWriteLock + + @tags{Core} */ class JUCE_API ScopedReadLock { diff --git a/modules/juce_core/threads/juce_ScopedWriteLock.h b/modules/juce_core/threads/juce_ScopedWriteLock.h index 7a9e8e53ef..3bfaf4b86e 100644 --- a/modules/juce_core/threads/juce_ScopedWriteLock.h +++ b/modules/juce_core/threads/juce_ScopedWriteLock.h @@ -45,6 +45,8 @@ namespace juce @endcode @see ReadWriteLock, ScopedReadLock + + @tags{Core} */ class JUCE_API ScopedWriteLock { diff --git a/modules/juce_core/threads/juce_SpinLock.h b/modules/juce_core/threads/juce_SpinLock.h index e8ea51e158..88e008bbbc 100644 --- a/modules/juce_core/threads/juce_SpinLock.h +++ b/modules/juce_core/threads/juce_SpinLock.h @@ -35,6 +35,8 @@ namespace juce lock for a very brief time. @see CriticalSection + + @tags{Core} */ class JUCE_API SpinLock { diff --git a/modules/juce_core/threads/juce_Thread.h b/modules/juce_core/threads/juce_Thread.h index fc5e426d88..ccc66b0990 100644 --- a/modules/juce_core/threads/juce_Thread.h +++ b/modules/juce_core/threads/juce_Thread.h @@ -36,6 +36,8 @@ namespace juce @see CriticalSection, WaitableEvent, Process, ThreadWithProgressWindow, MessageManagerLock + + @tags{Core} */ class JUCE_API Thread { @@ -173,6 +175,7 @@ public: bool waitForThreadToExit (int timeOutMilliseconds) const; //============================================================================== + /** Used to receive callbacks for thread exit calls */ class Listener { public: diff --git a/modules/juce_core/threads/juce_ThreadLocalValue.h b/modules/juce_core/threads/juce_ThreadLocalValue.h index ca2630976d..18efd11fbd 100644 --- a/modules/juce_core/threads/juce_ThreadLocalValue.h +++ b/modules/juce_core/threads/juce_ThreadLocalValue.h @@ -40,6 +40,8 @@ namespace juce to allow the storage to be re-used by another thread. If a thread exits without calling this method, the object storage will be left allocated until the ThreadLocalValue object is deleted. + + @tags{Core} */ template class ThreadLocalValue diff --git a/modules/juce_core/threads/juce_ThreadPool.h b/modules/juce_core/threads/juce_ThreadPool.h index f9483d0714..4612faa51b 100644 --- a/modules/juce_core/threads/juce_ThreadPool.h +++ b/modules/juce_core/threads/juce_ThreadPool.h @@ -40,6 +40,8 @@ class ThreadPoolThread; true, the runJob() method must return immediately. @see ThreadPool, Thread + + @tags{Core} */ class JUCE_API ThreadPoolJob { @@ -150,6 +152,8 @@ private: will be called by the next pooled thread that becomes free. @see ThreadPoolJob, Thread + + @tags{Core} */ class JUCE_API ThreadPool { diff --git a/modules/juce_core/threads/juce_TimeSliceThread.h b/modules/juce_core/threads/juce_TimeSliceThread.h index 8f4cacd62a..108a7349b6 100644 --- a/modules/juce_core/threads/juce_TimeSliceThread.h +++ b/modules/juce_core/threads/juce_TimeSliceThread.h @@ -37,6 +37,8 @@ class TimeSliceThread; deleting your client! @see TimeSliceThread + + @tags{Core} */ class JUCE_API TimeSliceClient { @@ -74,6 +76,8 @@ private: all a chance to run some sort of short task. @see TimeSliceClient, Thread + + @tags{Core} */ class JUCE_API TimeSliceThread : public Thread { diff --git a/modules/juce_core/threads/juce_WaitableEvent.h b/modules/juce_core/threads/juce_WaitableEvent.h index e13ec398d9..1701eab625 100644 --- a/modules/juce_core/threads/juce_WaitableEvent.h +++ b/modules/juce_core/threads/juce_WaitableEvent.h @@ -30,6 +30,8 @@ namespace juce A thread can call wait() on a WaitableObject, and this will suspend the calling thread until another thread wakes it up by calling the signal() method. + + @tags{Core} */ class JUCE_API WaitableEvent { diff --git a/modules/juce_core/time/juce_PerformanceCounter.h b/modules/juce_core/time/juce_PerformanceCounter.h index 7076ad1f75..6a1d9a2352 100644 --- a/modules/juce_core/time/juce_PerformanceCounter.h +++ b/modules/juce_core/time/juce_PerformanceCounter.h @@ -43,6 +43,8 @@ namespace juce In this example, the time of each period between calling start/stop will be measured and averaged over 50 runs, and the results printed to a file every 50 times round the loop. + + @tags{Core} */ class JUCE_API PerformanceCounter { @@ -135,6 +137,8 @@ private: } @param resultInSeconds The result of the measurement will be stored in this variable. + + @tags{Core} */ class JUCE_API ScopedTimeMeasurement { diff --git a/modules/juce_core/time/juce_RelativeTime.h b/modules/juce_core/time/juce_RelativeTime.h index 7ccbce2cd1..8bda4828ee 100644 --- a/modules/juce_core/time/juce_RelativeTime.h +++ b/modules/juce_core/time/juce_RelativeTime.h @@ -30,6 +30,8 @@ namespace juce point accuracy, and may be positive or negative. If you need an absolute time, (i.e. a date + time), see the Time class. + + @tags{Core} */ class JUCE_API RelativeTime { diff --git a/modules/juce_core/time/juce_Time.h b/modules/juce_core/time/juce_Time.h index 3395d5ddaa..e80ddc04e1 100644 --- a/modules/juce_core/time/juce_Time.h +++ b/modules/juce_core/time/juce_Time.h @@ -30,6 +30,8 @@ namespace juce Internally, the time is stored at millisecond precision. @see RelativeTime + + @tags{Core} */ class JUCE_API Time { diff --git a/modules/juce_core/unit_tests/juce_UnitTest.h b/modules/juce_core/unit_tests/juce_UnitTest.h index 048f53a58e..4cf2646ef0 100644 --- a/modules/juce_core/unit_tests/juce_UnitTest.h +++ b/modules/juce_core/unit_tests/juce_UnitTest.h @@ -63,6 +63,8 @@ class UnitTestRunner; To run a test, use the UnitTestRunner class. @see UnitTestRunner + + @tags{Core} */ class JUCE_API UnitTest { @@ -316,6 +318,8 @@ private: perform custom behaviour when each test completes. @see UnitTest + + @tags{Core} */ class JUCE_API UnitTestRunner { diff --git a/modules/juce_core/xml/juce_XmlDocument.h b/modules/juce_core/xml/juce_XmlDocument.h index 53e62888e6..bf380e8a43 100644 --- a/modules/juce_core/xml/juce_XmlDocument.h +++ b/modules/juce_core/xml/juce_XmlDocument.h @@ -59,6 +59,8 @@ namespace juce @endcode @see XmlElement + + @tags{Core} */ class JUCE_API XmlDocument { diff --git a/modules/juce_core/xml/juce_XmlElement.h b/modules/juce_core/xml/juce_XmlElement.h index eb02e4abd9..22c497439b 100644 --- a/modules/juce_core/xml/juce_XmlElement.h +++ b/modules/juce_core/xml/juce_XmlElement.h @@ -131,6 +131,8 @@ namespace juce @endcode @see XmlDocument + + @tags{Core} */ class JUCE_API XmlElement { diff --git a/modules/juce_core/zip/juce_GZIPCompressorOutputStream.h b/modules/juce_core/zip/juce_GZIPCompressorOutputStream.h index 02da3a7fee..5755e6f5e6 100644 --- a/modules/juce_core/zip/juce_GZIPCompressorOutputStream.h +++ b/modules/juce_core/zip/juce_GZIPCompressorOutputStream.h @@ -32,6 +32,8 @@ namespace juce it, and any subsequent attempts to call write() will cause an assertion. @see GZIPDecompressorInputStream + + @tags{Core} */ class JUCE_API GZIPCompressorOutputStream : public OutputStream { diff --git a/modules/juce_core/zip/juce_GZIPDecompressorInputStream.h b/modules/juce_core/zip/juce_GZIPDecompressorInputStream.h index 171ccd8ef9..f10f2b62cc 100644 --- a/modules/juce_core/zip/juce_GZIPDecompressorInputStream.h +++ b/modules/juce_core/zip/juce_GZIPDecompressorInputStream.h @@ -32,6 +32,8 @@ namespace juce BufferedInputStream, so that it has to read larger blocks less often. @see GZIPCompressorOutputStream + + @tags{Core} */ class JUCE_API GZIPDecompressorInputStream : public InputStream { diff --git a/modules/juce_core/zip/juce_ZipFile.h b/modules/juce_core/zip/juce_ZipFile.h index b97ac51b87..0b4dcb8a88 100644 --- a/modules/juce_core/zip/juce_ZipFile.h +++ b/modules/juce_core/zip/juce_ZipFile.h @@ -29,6 +29,8 @@ namespace juce This can enumerate the items in a ZIP file and can create suitable stream objects to read each one. + + @tags{Core} */ class JUCE_API ZipFile { diff --git a/modules/juce_cryptography/encryption/juce_BlowFish.h b/modules/juce_cryptography/encryption/juce_BlowFish.h index cdabc1ac68..8133c85b71 100644 --- a/modules/juce_cryptography/encryption/juce_BlowFish.h +++ b/modules/juce_cryptography/encryption/juce_BlowFish.h @@ -31,6 +31,8 @@ namespace juce /** BlowFish encryption class. + + @tags{Cryptography} */ class JUCE_API BlowFish { diff --git a/modules/juce_cryptography/encryption/juce_Primes.h b/modules/juce_cryptography/encryption/juce_Primes.h index 7adcddb0cb..7988a5fb24 100644 --- a/modules/juce_cryptography/encryption/juce_Primes.h +++ b/modules/juce_cryptography/encryption/juce_Primes.h @@ -34,6 +34,8 @@ namespace juce This class contains static methods for generating and testing prime numbers. @see BigInteger + + @tags{Cryptography} */ class JUCE_API Primes { diff --git a/modules/juce_cryptography/encryption/juce_RSAKey.h b/modules/juce_cryptography/encryption/juce_RSAKey.h index 334513ea0f..bce15e1acd 100644 --- a/modules/juce_cryptography/encryption/juce_RSAKey.h +++ b/modules/juce_cryptography/encryption/juce_RSAKey.h @@ -89,6 +89,8 @@ namespace juce Disclaimer: neither of the code snippets above are tested! Please let me know if you have any corrections for them! + + @tags{Cryptography} */ class JUCE_API RSAKey { diff --git a/modules/juce_cryptography/hashing/juce_MD5.h b/modules/juce_cryptography/hashing/juce_MD5.h index 4d4fa16cb7..4782792ae9 100644 --- a/modules/juce_cryptography/hashing/juce_MD5.h +++ b/modules/juce_cryptography/hashing/juce_MD5.h @@ -36,6 +36,8 @@ namespace juce You can then retrieve this checksum as a 16-byte block, or as a hex string. @see SHA256 + + @tags{Cryptography} */ class JUCE_API MD5 { diff --git a/modules/juce_cryptography/hashing/juce_SHA256.h b/modules/juce_cryptography/hashing/juce_SHA256.h index de56d5e9c1..eafc150592 100644 --- a/modules/juce_cryptography/hashing/juce_SHA256.h +++ b/modules/juce_cryptography/hashing/juce_SHA256.h @@ -36,6 +36,8 @@ namespace juce You can retrieve the hash as a raw 32-byte block, or as a 64-digit hex string. @see MD5 + + @tags{Cryptography} */ class JUCE_API SHA256 { diff --git a/modules/juce_cryptography/hashing/juce_Whirlpool.h b/modules/juce_cryptography/hashing/juce_Whirlpool.h index b04622fbaa..5834bb4203 100644 --- a/modules/juce_cryptography/hashing/juce_Whirlpool.h +++ b/modules/juce_cryptography/hashing/juce_Whirlpool.h @@ -42,6 +42,8 @@ namespace juce https://www.cosic.esat.kuleuven.ac.be/nessie/workshop/submissions/whirlpool.zip @see SHA256, MD5 + + @tags{Cryptography} */ class JUCE_API Whirlpool { diff --git a/modules/juce_data_structures/app_properties/juce_ApplicationProperties.h b/modules/juce_data_structures/app_properties/juce_ApplicationProperties.h index 6563b72cb5..3c7759c5ab 100644 --- a/modules/juce_data_structures/app_properties/juce_ApplicationProperties.h +++ b/modules/juce_data_structures/app_properties/juce_ApplicationProperties.h @@ -45,6 +45,8 @@ namespace juce its files. @see PropertiesFile + + @tags{DataStructures} */ class JUCE_API ApplicationProperties { diff --git a/modules/juce_data_structures/app_properties/juce_PropertiesFile.h b/modules/juce_data_structures/app_properties/juce_PropertiesFile.h index e4259e3e9a..83179cb9ef 100644 --- a/modules/juce_data_structures/app_properties/juce_PropertiesFile.h +++ b/modules/juce_data_structures/app_properties/juce_PropertiesFile.h @@ -40,6 +40,8 @@ namespace juce with it, and these will be signalled when a value changes. @see PropertySet + + @tags{DataStructures} */ class JUCE_API PropertiesFile : public PropertySet, public ChangeBroadcaster, @@ -55,6 +57,7 @@ public: }; //============================================================================== + /** Structure describing properties file options */ struct JUCE_API Options { /** Creates an empty Options structure. diff --git a/modules/juce_data_structures/undomanager/juce_UndoManager.h b/modules/juce_data_structures/undomanager/juce_UndoManager.h index f7a356f8d5..2edc581872 100644 --- a/modules/juce_data_structures/undomanager/juce_UndoManager.h +++ b/modules/juce_data_structures/undomanager/juce_UndoManager.h @@ -46,6 +46,8 @@ namespace juce when actions are performed or undone. @see UndoableAction + + @tags{DataStructures} */ class JUCE_API UndoManager : public ChangeBroadcaster { diff --git a/modules/juce_data_structures/undomanager/juce_UndoableAction.h b/modules/juce_data_structures/undomanager/juce_UndoableAction.h index 9b418cd4ff..058dc07396 100644 --- a/modules/juce_data_structures/undomanager/juce_UndoableAction.h +++ b/modules/juce_data_structures/undomanager/juce_UndoableAction.h @@ -33,6 +33,8 @@ namespace juce and undone. @see UndoManager + + @tags{DataStructures} */ class JUCE_API UndoableAction { diff --git a/modules/juce_data_structures/values/juce_CachedValue.h b/modules/juce_data_structures/values/juce_CachedValue.h index 7a807df300..ef974a8cca 100644 --- a/modules/juce_data_structures/values/juce_CachedValue.h +++ b/modules/juce_data_structures/values/juce_CachedValue.h @@ -52,6 +52,8 @@ namespace juce out-of-the-box, but if you want to use more complex custom types, you may need to implement some template specialisations of VariantConverter which this class uses to convert between the type and the ValueTree's internal var. + + @tags{DataStructures} */ template class CachedValue : private ValueTree::Listener diff --git a/modules/juce_data_structures/values/juce_Value.h b/modules/juce_data_structures/values/juce_Value.h index aa4ea5db49..aa6fe21dbf 100644 --- a/modules/juce_data_structures/values/juce_Value.h +++ b/modules/juce_data_structures/values/juce_Value.h @@ -45,6 +45,8 @@ namespace juce Important note! The Value class is not thread-safe! If you're accessing one from multiple threads, then you'll need to use your own synchronisation around any code that accesses it. + + @tags{DataStructures} */ class JUCE_API Value final { diff --git a/modules/juce_data_structures/values/juce_ValueTree.h b/modules/juce_data_structures/values/juce_ValueTree.h index 9a86ada6bb..06505423dc 100644 --- a/modules/juce_data_structures/values/juce_ValueTree.h +++ b/modules/juce_data_structures/values/juce_ValueTree.h @@ -66,6 +66,8 @@ namespace juce sub-trees are added or removed. @see var, XmlElement + + @tags{DataStructures} */ class JUCE_API ValueTree final { diff --git a/modules/juce_data_structures/values/juce_ValueTreeSynchroniser.h b/modules/juce_data_structures/values/juce_ValueTreeSynchroniser.h index 42c3823602..65c152267f 100644 --- a/modules/juce_data_structures/values/juce_ValueTreeSynchroniser.h +++ b/modules/juce_data_structures/values/juce_ValueTreeSynchroniser.h @@ -40,6 +40,8 @@ namespace juce and implement the stateChanged() method to transmit the encoded change (maybe via a network or other means) to a remote destination, where it can be applied to a target tree. + + @tags{DataStructures} */ class JUCE_API ValueTreeSynchroniser : private ValueTree::Listener { diff --git a/modules/juce_data_structures/values/juce_ValueWithDefault.h b/modules/juce_data_structures/values/juce_ValueWithDefault.h index 72f8e29fa8..002f9a1d4b 100644 --- a/modules/juce_data_structures/values/juce_ValueWithDefault.h +++ b/modules/juce_data_structures/values/juce_ValueWithDefault.h @@ -33,6 +33,8 @@ namespace juce If the property inside the ValueTree is missing or empty the ValueWithDefault will automatically return a default value, which can be specified when initialising the ValueWithDefault. + + @tags{DataStructures} */ class ValueWithDefault { diff --git a/modules/juce_dsp/containers/juce_AudioBlock.h b/modules/juce_dsp/containers/juce_AudioBlock.h index 1c53dcae2e..aa13b7039b 100644 --- a/modules/juce_dsp/containers/juce_AudioBlock.h +++ b/modules/juce_dsp/containers/juce_AudioBlock.h @@ -50,6 +50,8 @@ namespace SampleTypeHelpers // Internal classes needed for handling sample type an AudioBuffer which it can refer to, but in all cases the user is responsible for making sure that the data doesn't get deleted while there's still an AudioBlock using it. + + @tags{DSP} */ template class AudioBlock diff --git a/modules/juce_dsp/containers/juce_SIMDRegister.h b/modules/juce_dsp/containers/juce_SIMDRegister.h index 5afdd09707..ad9730894c 100644 --- a/modules/juce_dsp/containers/juce_SIMDRegister.h +++ b/modules/juce_dsp/containers/juce_SIMDRegister.h @@ -56,6 +56,8 @@ namespace dsp Note that using SIMDRegister without enabling optimizations will result in code with very poor performance. + + @tags{DSP} */ template struct SIMDRegister @@ -369,6 +371,7 @@ private: } }; +#ifndef DOXYGEN //============================================================================== /* This class is used internally by SIMDRegister to abstract away differences in operations which are different for complex and pure floating point types. */ @@ -459,6 +462,7 @@ struct CmplxSIMDOps> return SIMDNativeOps::add (a, SIMDNativeOps::cmplxmul (b, c)); } }; +#endif //============================================================================== #ifndef DOXYGEN diff --git a/modules/juce_dsp/filter_design/juce_FilterDesign.h b/modules/juce_dsp/filter_design/juce_FilterDesign.h index 92489e123c..9b00d3ee41 100755 --- a/modules/juce_dsp/filter_design/juce_FilterDesign.h +++ b/modules/juce_dsp/filter_design/juce_FilterDesign.h @@ -35,6 +35,8 @@ namespace dsp for processing directly audio as an equalizer, in resampling algorithms etc. see FIRFilter::Coefficients, FIRFilter, WindowingFunction, IIRFilter::Coefficients, IIRFilter + + @tags{DSP} */ template struct FilterDesign diff --git a/modules/juce_dsp/frequency/juce_Convolution.h b/modules/juce_dsp/frequency/juce_Convolution.h index 50eb8ebde9..46e863bcd5 100644 --- a/modules/juce_dsp/frequency/juce_Convolution.h +++ b/modules/juce_dsp/frequency/juce_Convolution.h @@ -44,6 +44,8 @@ namespace dsp the impulse response is higher than 64 samples. @see FIRFilter, FIRFilter::Coefficients, FFT + + @tags{DSP} */ class JUCE_API Convolution { diff --git a/modules/juce_dsp/frequency/juce_FFT.h b/modules/juce_dsp/frequency/juce_FFT.h index 7879684d7c..10da05144c 100644 --- a/modules/juce_dsp/frequency/juce_FFT.h +++ b/modules/juce_dsp/frequency/juce_FFT.h @@ -39,6 +39,8 @@ namespace dsp The FFT class itself contains lookup tables, so there's some overhead in creating one, you should create and cache an FFT object for each size/direction of transform that you need, and re-use them to perform the actual operation. + + @tags{DSP} */ class JUCE_API FFT { diff --git a/modules/juce_dsp/frequency/juce_Windowing.h b/modules/juce_dsp/frequency/juce_Windowing.h index 81c9ea247c..018748eab2 100644 --- a/modules/juce_dsp/frequency/juce_Windowing.h +++ b/modules/juce_dsp/frequency/juce_Windowing.h @@ -32,6 +32,8 @@ namespace dsp /** A class which provides multiple windowing functions useful for filter design and spectrum analyzers + + @tags{DSP} */ template struct WindowingFunction diff --git a/modules/juce_dsp/maths/juce_FastMathApproximations.h b/modules/juce_dsp/maths/juce_FastMathApproximations.h index 3be0473c23..e3912d8b26 100644 --- a/modules/juce_dsp/maths/juce_FastMathApproximations.h +++ b/modules/juce_dsp/maths/juce_FastMathApproximations.h @@ -31,6 +31,8 @@ namespace dsp /** This class contains various fast mathematical function approximations. + + @tags{DSP} */ struct FastMathApproximations { diff --git a/modules/juce_dsp/maths/juce_LookupTable.h b/modules/juce_dsp/maths/juce_LookupTable.h index a4d4061f69..970f56a66a 100644 --- a/modules/juce_dsp/maths/juce_LookupTable.h +++ b/modules/juce_dsp/maths/juce_LookupTable.h @@ -46,6 +46,8 @@ namespace dsp auto outValue = lut[17]; @see LookupTableTransform + + @tags{DSP} */ template class LookupTable @@ -166,6 +168,8 @@ private: range, it will return either the first or the last recorded LookupTable value. @see LookupTable + + @tags{DSP} */ template class LookupTableTransform diff --git a/modules/juce_dsp/maths/juce_Matrix.h b/modules/juce_dsp/maths/juce_Matrix.h index 59018a0501..7d856a0980 100644 --- a/modules/juce_dsp/maths/juce_Matrix.h +++ b/modules/juce_dsp/maths/juce_Matrix.h @@ -34,6 +34,8 @@ namespace dsp additions, multiplications, and linear systems of equations solving. @see LinearAlgebra + + @tags{DSP} */ template class Matrix diff --git a/modules/juce_dsp/maths/juce_Phase.h b/modules/juce_dsp/maths/juce_Phase.h index 11817196cf..b44bf7e91f 100644 --- a/modules/juce_dsp/maths/juce_Phase.h +++ b/modules/juce_dsp/maths/juce_Phase.h @@ -34,6 +34,8 @@ namespace dsp This represents a value which can be incremented, and which wraps back to 0 when it goes past 2 * pi. + + @tags{DSP} */ template struct Phase diff --git a/modules/juce_dsp/maths/juce_Polynomial.h b/modules/juce_dsp/maths/juce_Polynomial.h index c12ca32a11..fb5ccbfd04 100644 --- a/modules/juce_dsp/maths/juce_Polynomial.h +++ b/modules/juce_dsp/maths/juce_Polynomial.h @@ -31,6 +31,8 @@ namespace dsp /** A class representing a polynomial + + @tags{DSP} */ template class Polynomial diff --git a/modules/juce_dsp/maths/juce_SpecialFunctions.h b/modules/juce_dsp/maths/juce_SpecialFunctions.h index 275aac21e5..9a0291e23a 100644 --- a/modules/juce_dsp/maths/juce_SpecialFunctions.h +++ b/modules/juce_dsp/maths/juce_SpecialFunctions.h @@ -31,6 +31,8 @@ namespace dsp /** Contains miscellaneous filter design and windowing functions. + + @tags{DSP} */ struct SpecialFunctions { diff --git a/modules/juce_dsp/native/juce_avx_SIMDNativeOps.h b/modules/juce_dsp/native/juce_avx_SIMDNativeOps.h index 694620a5fa..696f810e3b 100644 --- a/modules/juce_dsp/native/juce_avx_SIMDNativeOps.h +++ b/modules/juce_dsp/native/juce_avx_SIMDNativeOps.h @@ -51,7 +51,10 @@ template struct SIMDNativeOps; //============================================================================== -/** Single-precision floating point AVX intrinsics. */ +/** Single-precision floating point AVX intrinsics. + + @tags{DSP} +*/ template <> struct SIMDNativeOps { @@ -111,7 +114,10 @@ struct SIMDNativeOps }; //============================================================================== -/** Double-precision floating point AVX intrinsics. */ +/** Double-precision floating point AVX intrinsics. + + @tags{DSP} +*/ template <> struct SIMDNativeOps { @@ -167,7 +173,10 @@ struct SIMDNativeOps }; //============================================================================== -/** Signed 8-bit integer AVX intrinsics */ +/** Signed 8-bit integer AVX intrinsics + + @tags{DSP} +*/ template <> struct SIMDNativeOps { @@ -238,7 +247,10 @@ struct SIMDNativeOps }; //============================================================================== -/** Unsigned 8-bit integer AVX intrinsics. */ +/** Unsigned 8-bit integer AVX intrinsics. + + @tags{DSP} +*/ template <> struct SIMDNativeOps { @@ -312,7 +324,10 @@ struct SIMDNativeOps }; //============================================================================== -/** Signed 16-bit integer AVX intrinsics. */ +/** Signed 16-bit integer AVX intrinsics. + + @tags{DSP} +*/ template <> struct SIMDNativeOps { @@ -365,7 +380,10 @@ struct SIMDNativeOps }; //============================================================================== -/** Unsigned 16-bit integer AVX intrinsics. */ +/** Unsigned 16-bit integer AVX intrinsics. + + @tags{DSP} +*/ template <> struct SIMDNativeOps { @@ -421,7 +439,10 @@ struct SIMDNativeOps }; //============================================================================== -/** Signed 32-bit integer AVX intrinsics. */ +/** Signed 32-bit integer AVX intrinsics. + + @tags{DSP} +*/ template <> struct SIMDNativeOps { @@ -472,7 +493,10 @@ struct SIMDNativeOps }; //============================================================================== -/** Unsigned 32-bit integer AVX intrinsics. */ +/** Unsigned 32-bit integer AVX intrinsics. + + @tags{DSP} +*/ template <> struct SIMDNativeOps { @@ -526,7 +550,10 @@ struct SIMDNativeOps }; //============================================================================== -/** Signed 64-bit integer AVX intrinsics. */ +/** Signed 64-bit integer AVX intrinsics. + + @tags{DSP} +*/ template <> struct SIMDNativeOps { @@ -596,7 +623,10 @@ struct SIMDNativeOps }; //============================================================================== -/** Unsigned 64-bit integer AVX intrinsics. */ +/** Unsigned 64-bit integer AVX intrinsics. + + @tags{DSP} +*/ template <> struct SIMDNativeOps { diff --git a/modules/juce_dsp/native/juce_fallback_SIMDNativeOps.h b/modules/juce_dsp/native/juce_fallback_SIMDNativeOps.h index 3d5325a9a4..d7336c8818 100644 --- a/modules/juce_dsp/native/juce_fallback_SIMDNativeOps.h +++ b/modules/juce_dsp/native/juce_fallback_SIMDNativeOps.h @@ -53,6 +53,8 @@ namespace SIMDInternal /** Useful fallback routines to use if the native SIMD op is not supported. You should never need to use this directly. Use juce_SIMDRegister instead. + + @tags{DSP} */ template struct SIMDFallbackOps diff --git a/modules/juce_dsp/native/juce_neon_SIMDNativeOps.h b/modules/juce_dsp/native/juce_neon_SIMDNativeOps.h index ddced57ec6..2fc7b1ee48 100644 --- a/modules/juce_dsp/native/juce_neon_SIMDNativeOps.h +++ b/modules/juce_dsp/native/juce_neon_SIMDNativeOps.h @@ -51,7 +51,10 @@ template struct SIMDNativeOps; //============================================================================== -/** Unsigned 32-bit integer NEON intrinsics. */ +/** Unsigned 32-bit integer NEON intrinsics. + + @tags{DSP} +*/ template <> struct SIMDNativeOps { @@ -90,7 +93,10 @@ struct SIMDNativeOps }; //============================================================================== -/** Signed 32-bit integer NEON intrinsics. */ +/** Signed 32-bit integer NEON intrinsics. + + @tags{DSP} +*/ template <> struct SIMDNativeOps { @@ -130,7 +136,10 @@ struct SIMDNativeOps }; //============================================================================== -/** Signed 8-bit integer NEON intrinsics. */ +/** Signed 8-bit integer NEON intrinsics. + + @tags{DSP} +*/ template <> struct SIMDNativeOps { @@ -165,7 +174,10 @@ struct SIMDNativeOps }; //============================================================================== -/** Unsigned 8-bit integer NEON intrinsics. */ +/** Unsigned 8-bit integer NEON intrinsics. + + @tags{DSP} +*/ template <> struct SIMDNativeOps { @@ -200,7 +212,10 @@ struct SIMDNativeOps }; //============================================================================== -/** Signed 16-bit integer NEON intrinsics. */ +/** Signed 16-bit integer NEON intrinsics. + + @tags{DSP} +*/ template <> struct SIMDNativeOps { @@ -236,7 +251,10 @@ struct SIMDNativeOps //============================================================================== -/** Unsigned 16-bit integer NEON intrinsics. */ +/** Unsigned 16-bit integer NEON intrinsics. + + @tags{DSP} +*/ template <> struct SIMDNativeOps { @@ -271,7 +289,10 @@ struct SIMDNativeOps }; //============================================================================== -/** Signed 64-bit integer NEON intrinsics. */ +/** Signed 64-bit integer NEON intrinsics. + + @tags{DSP} +*/ template <> struct SIMDNativeOps { @@ -307,7 +328,10 @@ struct SIMDNativeOps //============================================================================== -/** Unsigned 64-bit integer NEON intrinsics. */ +/** Unsigned 64-bit integer NEON intrinsics. + + @tags{DSP} +*/ template <> struct SIMDNativeOps { @@ -342,7 +366,10 @@ struct SIMDNativeOps }; //============================================================================== -/** Single-precision floating point NEON intrinsics. */ +/** Single-precision floating point NEON intrinsics. + + @tags{DSP} +*/ template <> struct SIMDNativeOps { @@ -399,6 +426,8 @@ struct SIMDNativeOps //============================================================================== /** Double-precision floating point NEON intrinsics does not exist in NEON so we need to emulate this. + + @tags{DSP} */ template <> struct SIMDNativeOps diff --git a/modules/juce_dsp/native/juce_sse_SIMDNativeOps.h b/modules/juce_dsp/native/juce_sse_SIMDNativeOps.h index a60d5d41ef..a11186abf9 100644 --- a/modules/juce_dsp/native/juce_sse_SIMDNativeOps.h +++ b/modules/juce_dsp/native/juce_sse_SIMDNativeOps.h @@ -51,7 +51,10 @@ template struct SIMDNativeOps; //============================================================================== -/** Single-precision floating point SSE intrinsics. */ +/** Single-precision floating point SSE intrinsics. + + @tags{DSP} +*/ template <> struct SIMDNativeOps { @@ -111,7 +114,10 @@ struct SIMDNativeOps }; //============================================================================== -/** Double-precision floating point SSE intrinsics. */ +/** Double-precision floating point SSE intrinsics. + + @tags{DSP} +*/ template <> struct SIMDNativeOps { @@ -172,7 +178,10 @@ struct SIMDNativeOps }; //============================================================================== -/** Signed 8-bit integer SSE intrinsics. */ +/** Signed 8-bit integer SSE intrinsics. + + @tags{DSP} +*/ template <> struct SIMDNativeOps { @@ -257,7 +266,10 @@ struct SIMDNativeOps }; //============================================================================== -/** Unsigned 8-bit integer SSE intrinsics. */ +/** Unsigned 8-bit integer SSE intrinsics. + + @tags{DSP} +*/ template <> struct SIMDNativeOps { @@ -339,7 +351,10 @@ struct SIMDNativeOps }; //============================================================================== -/** Signed 16-bit integer SSE intrinsics. */ +/** Signed 16-bit integer SSE intrinsics. + + @tags{DSP} +*/ template <> struct SIMDNativeOps { @@ -401,7 +416,10 @@ struct SIMDNativeOps }; //============================================================================== -/** Unsigned 16-bit integer SSE intrinsics. */ +/** Unsigned 16-bit integer SSE intrinsics. + + @tags{DSP} +*/ template <> struct SIMDNativeOps { @@ -470,7 +488,10 @@ struct SIMDNativeOps }; //============================================================================== -/** Signed 32-bit integer SSE intrinsics. */ +/** Signed 32-bit integer SSE intrinsics. + + @tags{DSP} +*/ template <> struct SIMDNativeOps { @@ -555,7 +576,10 @@ struct SIMDNativeOps }; //============================================================================== -/** Unsigned 32-bit integer SSE intrinsics. */ +/** Unsigned 32-bit integer SSE intrinsics. + + @tags{DSP} +*/ template <> struct SIMDNativeOps { @@ -647,7 +671,10 @@ struct SIMDNativeOps }; //============================================================================== -/** Signed 64-bit integer SSE intrinsics. */ +/** Signed 64-bit integer SSE intrinsics. + + @tags{DSP} +*/ template <> struct SIMDNativeOps { @@ -738,7 +765,10 @@ struct SIMDNativeOps }; //============================================================================== -/** Unsigned 64-bit integer SSE intrinsics. */ +/** Unsigned 64-bit integer SSE intrinsics. + + @tags{DSP} +*/ template <> struct SIMDNativeOps { diff --git a/modules/juce_dsp/processors/juce_Bias.h b/modules/juce_dsp/processors/juce_Bias.h index 61ff049f72..aeb765db27 100644 --- a/modules/juce_dsp/processors/juce_Bias.h +++ b/modules/juce_dsp/processors/juce_Bias.h @@ -37,6 +37,8 @@ namespace dsp This is an extremely simple bias implementation that simply adds a value to a signal. More complicated bias behaviours exist in real circuits - for your homework ;). + + @tags{DSP} */ template class Bias diff --git a/modules/juce_dsp/processors/juce_FIRFilter.h b/modules/juce_dsp/processors/juce_FIRFilter.h index 4b589028f9..73b0b90f54 100644 --- a/modules/juce_dsp/processors/juce_FIRFilter.h +++ b/modules/juce_dsp/processors/juce_FIRFilter.h @@ -48,6 +48,8 @@ namespace FIR thanks to FFT. @see FIRFilter::Coefficients, Convolution, FFT + + @tags{DSP} */ template class Filter @@ -208,6 +210,8 @@ namespace FIR A set of coefficients for use in an FIRFilter object. @see FIRFilter + + @tags{DSP} */ template struct Coefficients : public ProcessorState diff --git a/modules/juce_dsp/processors/juce_Gain.h b/modules/juce_dsp/processors/juce_Gain.h index e7195369a2..5f8e46720e 100644 --- a/modules/juce_dsp/processors/juce_Gain.h +++ b/modules/juce_dsp/processors/juce_Gain.h @@ -31,6 +31,8 @@ namespace dsp /** Applies a gain to audio samples as single samples or AudioBlocks. + + @tags{DSP} */ template class Gain diff --git a/modules/juce_dsp/processors/juce_IIRFilter.h b/modules/juce_dsp/processors/juce_IIRFilter.h index ac991272b9..a111d8a3ca 100644 --- a/modules/juce_dsp/processors/juce_IIRFilter.h +++ b/modules/juce_dsp/processors/juce_IIRFilter.h @@ -24,13 +24,14 @@ ============================================================================== */ -/** - Classes for IIR filter processing. -*/ namespace juce { namespace dsp { + +/** + Classes for IIR filter processing. +*/ namespace IIR { template @@ -46,6 +47,8 @@ namespace IIR class Filter. @see Filter::Coefficients, FilterAudioSource, StateVariableFilter + + @tags{DSP} */ template class Filter @@ -144,6 +147,8 @@ namespace IIR //============================================================================== /** A set of coefficients for use in an Filter object. @see IIR::Filter + + @tags{DSP} */ template struct Coefficients : public ProcessorState diff --git a/modules/juce_dsp/processors/juce_LadderFilter.h b/modules/juce_dsp/processors/juce_LadderFilter.h index b4f7191cd8..612917124e 100644 --- a/modules/juce_dsp/processors/juce_LadderFilter.h +++ b/modules/juce_dsp/processors/juce_LadderFilter.h @@ -31,6 +31,8 @@ namespace dsp /** Multi-mode filter based on the Moog ladder filter. + + @tags{DSP} */ template class LadderFilter diff --git a/modules/juce_dsp/processors/juce_Oscillator.h b/modules/juce_dsp/processors/juce_Oscillator.h index 0e52f1f8b8..2031a892b4 100644 --- a/modules/juce_dsp/processors/juce_Oscillator.h +++ b/modules/juce_dsp/processors/juce_Oscillator.h @@ -31,6 +31,8 @@ namespace dsp /** Generates a signal based on a user-supplied function. + + @tags{DSP} */ template class Oscillator diff --git a/modules/juce_dsp/processors/juce_Oversampling.h b/modules/juce_dsp/processors/juce_Oversampling.h index 15c268acc8..878d3e9030 100644 --- a/modules/juce_dsp/processors/juce_Oversampling.h +++ b/modules/juce_dsp/processors/juce_Oversampling.h @@ -29,8 +29,10 @@ namespace juce namespace dsp { +#ifndef DOXYGEN template class OversamplingEngine; +#endif //=============================================================================== /** @@ -53,6 +55,8 @@ class OversamplingEngine; Nyquist frequency but the latency is minimum. @see FilterDesign. + + @tags{DSP} */ template class JUCE_API Oversampling diff --git a/modules/juce_dsp/processors/juce_ProcessContext.h b/modules/juce_dsp/processors/juce_ProcessContext.h index c8e6c6945a..c2ff8de484 100644 --- a/modules/juce_dsp/processors/juce_ProcessContext.h +++ b/modules/juce_dsp/processors/juce_ProcessContext.h @@ -32,6 +32,8 @@ namespace dsp /** This structure is passed into a DSP algorithm's prepare() method, and contains information about various aspects of the context in which it can expect to be called. + + @tags{DSP} */ struct ProcessSpec { @@ -50,6 +52,8 @@ struct ProcessSpec This is a handy base class for the state of a processor (such as parameter values) which is typically shared among several procoessors. This is useful to for multi-mono filters which share the same state among several mono processors. + + @tags{DSP} */ struct ProcessorState : public ReferenceCountedObject { @@ -68,6 +72,8 @@ struct ProcessorState : public ReferenceCountedObject getInputBlock() and getOutputBlock() methods. @see ProcessContextNonReplacing + + @tags{DSP} */ template struct ProcessContextReplacing @@ -117,6 +123,8 @@ private: getOutputBlock(). @see ProcessContextReplacing + + @tags{DSP} */ template struct ProcessContextNonReplacing diff --git a/modules/juce_dsp/processors/juce_ProcessorDuplicator.h b/modules/juce_dsp/processors/juce_ProcessorDuplicator.h index cd561bb388..398ba8131a 100644 --- a/modules/juce_dsp/processors/juce_ProcessorDuplicator.h +++ b/modules/juce_dsp/processors/juce_ProcessorDuplicator.h @@ -36,6 +36,8 @@ namespace dsp When the prepare method is called, it uses the specified number of channels to instantiate the appropriate number of instances, which it then uses in its process() method. + + @tags{DSP} */ template struct ProcessorDuplicator diff --git a/modules/juce_dsp/processors/juce_ProcessorWrapper.h b/modules/juce_dsp/processors/juce_ProcessorWrapper.h index 9df2b2090d..e15214967f 100644 --- a/modules/juce_dsp/processors/juce_ProcessorWrapper.h +++ b/modules/juce_dsp/processors/juce_ProcessorWrapper.h @@ -35,6 +35,8 @@ namespace dsp methods, so that you can use the ProcessorWrapper class to wrap an instance of a subclass, and then pass that around using ProcessorBase as a base class. @see ProcessorWrapper + + @tags{DSP} */ struct ProcessorBase { @@ -52,6 +54,8 @@ struct ProcessorBase Wraps an instance of a given processor class, and exposes it through the ProcessorBase interface. @see ProcessorBase + + @tags{DSP} */ template struct ProcessorWrapper : public ProcessorBase diff --git a/modules/juce_dsp/processors/juce_Reverb.h b/modules/juce_dsp/processors/juce_Reverb.h index 507a64e1ba..35a1fb496f 100644 --- a/modules/juce_dsp/processors/juce_Reverb.h +++ b/modules/juce_dsp/processors/juce_Reverb.h @@ -31,6 +31,8 @@ namespace dsp /** Processor wrapper around juce::Reverb for easy integration into ProcessorChain. + + @tags{DSP} */ class Reverb { diff --git a/modules/juce_dsp/processors/juce_StateVariableFilter.h b/modules/juce_dsp/processors/juce_StateVariableFilter.h index be356f8560..6caed43f7a 100644 --- a/modules/juce_dsp/processors/juce_StateVariableFilter.h +++ b/modules/juce_dsp/processors/juce_StateVariableFilter.h @@ -30,21 +30,26 @@ namespace dsp { /** - An IIR filter that can perform low, band and high-pass filtering on an audio - signal, with 12 dB of attenuation / octave, using a TPT structure, designed - for fast modulation (see Vadim Zavalishin's documentation about TPT - structures for more information). Its behaviour is based on the analog - state variable filter circuit. - - Note : the bandpass here is not the one in the RBJ CookBook, its gain can be - higher than 0 dB. For the classic 0 dB bandpass, we need to multiply the - result with R2 + Classes for state variable filter processing. */ namespace StateVariableFilter { template struct Parameters; + /** + An IIR filter that can perform low, band and high-pass filtering on an audio + signal, with 12 dB of attenuation / octave, using a TPT structure, designed + for fast modulation (see Vadim Zavalishin's documentation about TPT + structures for more information). Its behaviour is based on the analog + state variable filter circuit. + + Note : the bandpass here is not the one in the RBJ CookBook, its gain can be + higher than 0 dB. For the classic 0 dB bandpass, we need to multiply the + result with R2 + + @tags{DSP} + */ template class Filter { @@ -174,6 +179,11 @@ namespace StateVariableFilter }; //============================================================================== + /** + Structure used for the state variable filter parameters. + + @tags{DSP} + */ template struct Parameters : public ProcessorState { diff --git a/modules/juce_dsp/processors/juce_WaveShaper.h b/modules/juce_dsp/processors/juce_WaveShaper.h index 6ea543ebe3..693a5d2743 100644 --- a/modules/juce_dsp/processors/juce_WaveShaper.h +++ b/modules/juce_dsp/processors/juce_WaveShaper.h @@ -31,6 +31,8 @@ namespace dsp /** Applies waveshaping to audio samples as single samples or AudioBlocks. + + @tags{DSP} */ template struct WaveShaper diff --git a/modules/juce_events/broadcasters/juce_ActionBroadcaster.h b/modules/juce_events/broadcasters/juce_ActionBroadcaster.h index 3936253a2f..3abbbbb191 100644 --- a/modules/juce_events/broadcasters/juce_ActionBroadcaster.h +++ b/modules/juce_events/broadcasters/juce_ActionBroadcaster.h @@ -30,6 +30,8 @@ namespace juce listeners and broadcast to them, you can derive from this. @see ActionListener, ChangeListener + + @tags{Events} */ class JUCE_API ActionBroadcaster { diff --git a/modules/juce_events/broadcasters/juce_ActionListener.h b/modules/juce_events/broadcasters/juce_ActionListener.h index c16449f7df..910b82ab77 100644 --- a/modules/juce_events/broadcasters/juce_ActionListener.h +++ b/modules/juce_events/broadcasters/juce_ActionListener.h @@ -28,6 +28,8 @@ namespace juce Interface class for delivery of events that are sent by an ActionBroadcaster. @see ActionBroadcaster, ChangeListener + + @tags{Events} */ class JUCE_API ActionListener { diff --git a/modules/juce_events/broadcasters/juce_AsyncUpdater.h b/modules/juce_events/broadcasters/juce_AsyncUpdater.h index 7a94a63d63..2b73f72e30 100644 --- a/modules/juce_events/broadcasters/juce_AsyncUpdater.h +++ b/modules/juce_events/broadcasters/juce_AsyncUpdater.h @@ -32,6 +32,8 @@ namespace juce Basically, one or more calls to the triggerAsyncUpdate() will result in the message thread calling handleAsyncUpdate() as soon as it can. + + @tags{Events} */ class JUCE_API AsyncUpdater { diff --git a/modules/juce_events/broadcasters/juce_ChangeBroadcaster.h b/modules/juce_events/broadcasters/juce_ChangeBroadcaster.h index beef4e85a0..4777502c08 100644 --- a/modules/juce_events/broadcasters/juce_ChangeBroadcaster.h +++ b/modules/juce_events/broadcasters/juce_ChangeBroadcaster.h @@ -28,6 +28,8 @@ namespace juce Holds a list of ChangeListeners, and sends messages to them when instructed. @see ChangeListener + + @tags{Events} */ class JUCE_API ChangeBroadcaster { diff --git a/modules/juce_events/broadcasters/juce_ChangeListener.h b/modules/juce_events/broadcasters/juce_ChangeListener.h index aacaf223cd..438acc7d64 100644 --- a/modules/juce_events/broadcasters/juce_ChangeListener.h +++ b/modules/juce_events/broadcasters/juce_ChangeListener.h @@ -38,6 +38,8 @@ class ChangeBroadcaster; callbacks, but ActionListeners perform one callback for every event posted. @see ChangeBroadcaster, ActionListener + + @tags{Events} */ class JUCE_API ChangeListener { diff --git a/modules/juce_events/interprocess/juce_ConnectedChildProcess.h b/modules/juce_events/interprocess/juce_ConnectedChildProcess.h index b7a81cb3fa..138d1e711b 100644 --- a/modules/juce_events/interprocess/juce_ConnectedChildProcess.h +++ b/modules/juce_events/interprocess/juce_ConnectedChildProcess.h @@ -41,6 +41,8 @@ namespace juce The juce demo app has a good example of this class in action. @see ChildProcessMaster, InterprocessConnection, ChildProcess + + @tags{Events} */ class JUCE_API ChildProcessSlave { @@ -126,6 +128,8 @@ private: The juce demo app has a good example of this class in action. @see ChildProcessSlave, InterprocessConnection, ChildProcess + + @tags{Events} */ class JUCE_API ChildProcessMaster { diff --git a/modules/juce_events/interprocess/juce_InterprocessConnection.h b/modules/juce_events/interprocess/juce_InterprocessConnection.h index 5230c95b0d..fe10dfe6f1 100644 --- a/modules/juce_events/interprocess/juce_InterprocessConnection.h +++ b/modules/juce_events/interprocess/juce_InterprocessConnection.h @@ -44,6 +44,8 @@ class MemoryBlock; InterprocessConnectionServer class. @see InterprocessConnectionServer, Socket, NamedPipe + + @tags{Events} */ class JUCE_API InterprocessConnection { diff --git a/modules/juce_events/interprocess/juce_InterprocessConnectionServer.h b/modules/juce_events/interprocess/juce_InterprocessConnectionServer.h index 0305914e58..1654620b8a 100644 --- a/modules/juce_events/interprocess/juce_InterprocessConnectionServer.h +++ b/modules/juce_events/interprocess/juce_InterprocessConnectionServer.h @@ -33,6 +33,8 @@ namespace juce to connect. @see InterprocessConnection + + @tags{Events} */ class JUCE_API InterprocessConnectionServer : private Thread { diff --git a/modules/juce_events/messages/juce_ApplicationBase.h b/modules/juce_events/messages/juce_ApplicationBase.h index 2d5a3dbf7c..2aa34f2fcb 100644 --- a/modules/juce_events/messages/juce_ApplicationBase.h +++ b/modules/juce_events/messages/juce_ApplicationBase.h @@ -78,6 +78,8 @@ namespace juce @endcode @see JUCEApplication, START_JUCE_APPLICATION + + @tags{Events} */ class JUCE_API JUCEApplicationBase { diff --git a/modules/juce_events/messages/juce_CallbackMessage.h b/modules/juce_events/messages/juce_CallbackMessage.h index 303c1b438a..09edb8817b 100644 --- a/modules/juce_events/messages/juce_CallbackMessage.h +++ b/modules/juce_events/messages/juce_CallbackMessage.h @@ -42,6 +42,8 @@ namespace juce times you may prefer to use MessageManager::callAsync() with a lambda. @see MessageManager::callAsync, MessageListener, ActionListener, ChangeListener + + @tags{Events} */ class JUCE_API CallbackMessage : public MessageManager::MessageBase { diff --git a/modules/juce_events/messages/juce_DeletedAtShutdown.h b/modules/juce_events/messages/juce_DeletedAtShutdown.h index 9b28a49eda..4c785408bb 100644 --- a/modules/juce_events/messages/juce_DeletedAtShutdown.h +++ b/modules/juce_events/messages/juce_DeletedAtShutdown.h @@ -33,6 +33,8 @@ namespace juce So if you've got a singleton and don't want to have to explicitly delete it, just inherit from this and it'll be taken care of. + + @tags{Events} */ class JUCE_API DeletedAtShutdown { diff --git a/modules/juce_events/messages/juce_Initialisation.h b/modules/juce_events/messages/juce_Initialisation.h index a3dcd8c126..0a2985fb0c 100644 --- a/modules/juce_events/messages/juce_Initialisation.h +++ b/modules/juce_events/messages/juce_Initialisation.h @@ -63,6 +63,8 @@ JUCE_API void JUCE_CALLTYPE shutdownJuce_GUI(); Be careful with your threading though - to be safe, you should always make sure that these objects are created and deleted on the message thread. + + @tags{Events} */ class JUCE_API ScopedJuceInitialiser_GUI final { diff --git a/modules/juce_events/messages/juce_Message.h b/modules/juce_events/messages/juce_Message.h index c0abb238ce..49021e52f4 100644 --- a/modules/juce_events/messages/juce_Message.h +++ b/modules/juce_events/messages/juce_Message.h @@ -37,6 +37,8 @@ class MessageListener; deleted automatically after the message has been delivered. @see MessageListener, MessageManager, ActionListener, ChangeListener + + @tags{Events} */ class JUCE_API Message : public MessageManager::MessageBase { diff --git a/modules/juce_events/messages/juce_MessageListener.h b/modules/juce_events/messages/juce_MessageListener.h index 8c8fe9bd50..6923a9ded6 100644 --- a/modules/juce_events/messages/juce_MessageListener.h +++ b/modules/juce_events/messages/juce_MessageListener.h @@ -28,6 +28,8 @@ namespace juce MessageListener subclasses can post and receive Message objects. @see Message, MessageManager, ActionListener, ChangeListener + + @tags{Events} */ class JUCE_API MessageListener { diff --git a/modules/juce_events/messages/juce_MessageManager.h b/modules/juce_events/messages/juce_MessageManager.h index 6e6852839f..17241ec72d 100644 --- a/modules/juce_events/messages/juce_MessageManager.h +++ b/modules/juce_events/messages/juce_MessageManager.h @@ -43,6 +43,8 @@ typedef void* (MessageCallbackFunction) (void* userData); This class is in charge of the application's event-dispatch loop. @see Message, CallbackMessage, MessageManagerLock, JUCEApplication, JUCEApplicationBase + + @tags{Events} */ class JUCE_API MessageManager final { @@ -376,6 +378,8 @@ private: you'll get an (occasional) deadlock.. @see MessageManager, MessageManager::currentThreadHasLockedMessageManager + + @tags{Events} */ class JUCE_API MessageManagerLock : private Thread::Listener { diff --git a/modules/juce_events/messages/juce_MountedVolumeListChangeDetector.h b/modules/juce_events/messages/juce_MountedVolumeListChangeDetector.h index ccc00b11b9..3d3967b3f6 100644 --- a/modules/juce_events/messages/juce_MountedVolumeListChangeDetector.h +++ b/modules/juce_events/messages/juce_MountedVolumeListChangeDetector.h @@ -34,6 +34,8 @@ namespace juce to get the callbacks, there's no need to do anything else. @see File::findFileSystemRoots() + + @tags{Events} */ class JUCE_API MountedVolumeListChangeDetector { diff --git a/modules/juce_events/timers/juce_MultiTimer.h b/modules/juce_events/timers/juce_MultiTimer.h index 8921b68443..44df949cd0 100644 --- a/modules/juce_events/timers/juce_MultiTimer.h +++ b/modules/juce_events/timers/juce_MultiTimer.h @@ -39,6 +39,8 @@ namespace juce caused it. @see Timer + + @tags{Events} */ class JUCE_API MultiTimer { diff --git a/modules/juce_events/timers/juce_Timer.h b/modules/juce_events/timers/juce_Timer.h index 971faf977b..e1203a4bfd 100644 --- a/modules/juce_events/timers/juce_Timer.h +++ b/modules/juce_events/timers/juce_Timer.h @@ -45,6 +45,8 @@ namespace juce internally, each one identified by an ID number. @see HighResolutionTimer, MultiTimer + + @tags{Events} */ class JUCE_API Timer { diff --git a/modules/juce_graphics/colour/juce_Colour.h b/modules/juce_graphics/colour/juce_Colour.h index bc05b025a6..c239f3a883 100644 --- a/modules/juce_graphics/colour/juce_Colour.h +++ b/modules/juce_graphics/colour/juce_Colour.h @@ -32,6 +32,8 @@ namespace juce Represents a colour, also including a transparency value. The colour is stored internally as unsigned 8-bit red, green, blue and alpha values. + + @tags{Graphics} */ class JUCE_API Colour final { diff --git a/modules/juce_graphics/colour/juce_ColourGradient.h b/modules/juce_graphics/colour/juce_ColourGradient.h index 90c0eb05e0..33bafde1eb 100644 --- a/modules/juce_graphics/colour/juce_ColourGradient.h +++ b/modules/juce_graphics/colour/juce_ColourGradient.h @@ -32,6 +32,8 @@ namespace juce Describes the layout and colours that should be used to paint a colour gradient. @see Graphics::setGradientFill + + @tags{Graphics} */ class JUCE_API ColourGradient final { diff --git a/modules/juce_graphics/colour/juce_Colours.h b/modules/juce_graphics/colour/juce_Colours.h index c79911740a..2acb8d9fa4 100644 --- a/modules/juce_graphics/colour/juce_Colours.h +++ b/modules/juce_graphics/colour/juce_Colours.h @@ -32,6 +32,8 @@ namespace juce Contains a set of predefined named colours (mostly standard HTML colours) @see Colour + + @tags{Graphics} */ class Colours { diff --git a/modules/juce_graphics/colour/juce_FillType.h b/modules/juce_graphics/colour/juce_FillType.h index 808ad4f392..9ee12508f4 100644 --- a/modules/juce_graphics/colour/juce_FillType.h +++ b/modules/juce_graphics/colour/juce_FillType.h @@ -35,6 +35,8 @@ namespace juce a brush type. It can either be a solid colour, a gradient, or a tiled image. @see Graphics::setFillType, DrawablePath::setFill + + @tags{Graphics} */ class JUCE_API FillType final { diff --git a/modules/juce_graphics/colour/juce_PixelFormats.h b/modules/juce_graphics/colour/juce_PixelFormats.h index cb0867cfd0..4b1ba87da1 100644 --- a/modules/juce_graphics/colour/juce_PixelFormats.h +++ b/modules/juce_graphics/colour/juce_PixelFormats.h @@ -53,6 +53,8 @@ inline uint32 clampPixelComponents (uint32 x) noexcept This is used internally by the imaging classes. @see PixelRGB + + @tags{Graphics} */ class JUCE_API PixelARGB { @@ -358,6 +360,8 @@ private: This is used internally by the imaging classes. @see PixelARGB + + @tags{Graphics} */ class JUCE_API PixelRGB { @@ -607,6 +611,8 @@ forcedinline void PixelARGB::blend (const PixelRGB src) noexcept This is used internally by the imaging classes. @see PixelARGB, PixelRGB + + @tags{Graphics} */ class JUCE_API PixelAlpha { diff --git a/modules/juce_graphics/contexts/juce_GraphicsContext.h b/modules/juce_graphics/contexts/juce_GraphicsContext.h index 0142561ca4..15fed43d6c 100644 --- a/modules/juce_graphics/contexts/juce_GraphicsContext.h +++ b/modules/juce_graphics/contexts/juce_GraphicsContext.h @@ -39,6 +39,8 @@ namespace juce that image. @see Component::paint + + @tags{Graphics} */ class JUCE_API Graphics final { diff --git a/modules/juce_graphics/contexts/juce_LowLevelGraphicsContext.h b/modules/juce_graphics/contexts/juce_LowLevelGraphicsContext.h index a9828e3051..e4aff7ba67 100644 --- a/modules/juce_graphics/contexts/juce_LowLevelGraphicsContext.h +++ b/modules/juce_graphics/contexts/juce_LowLevelGraphicsContext.h @@ -40,6 +40,8 @@ namespace juce E.g. the LowLevelGraphicsSoftwareRenderer renders onto an image in memory, but other subclasses could render directly to a windows HDC, a Quartz context, or an OpenGL context. + + @tags{Graphics} */ class JUCE_API LowLevelGraphicsContext { diff --git a/modules/juce_graphics/contexts/juce_LowLevelGraphicsPostScriptRenderer.h b/modules/juce_graphics/contexts/juce_LowLevelGraphicsPostScriptRenderer.h index 569c557c8d..82ab607afc 100644 --- a/modules/juce_graphics/contexts/juce_LowLevelGraphicsPostScriptRenderer.h +++ b/modules/juce_graphics/contexts/juce_LowLevelGraphicsPostScriptRenderer.h @@ -32,6 +32,7 @@ namespace juce An implementation of LowLevelGraphicsContext that turns the drawing operations into a PostScript document. + @tags{Graphics} */ class JUCE_API LowLevelGraphicsPostScriptRenderer : public LowLevelGraphicsContext { @@ -91,6 +92,7 @@ protected: bool needToClip; Colour lastColour; + /** Describes a saved state */ struct SavedState { SavedState(); diff --git a/modules/juce_graphics/contexts/juce_LowLevelGraphicsSoftwareRenderer.h b/modules/juce_graphics/contexts/juce_LowLevelGraphicsSoftwareRenderer.h index 06ecca5e0a..b5a73db142 100644 --- a/modules/juce_graphics/contexts/juce_LowLevelGraphicsSoftwareRenderer.h +++ b/modules/juce_graphics/contexts/juce_LowLevelGraphicsSoftwareRenderer.h @@ -34,6 +34,8 @@ namespace juce User code is not supposed to create instances of this class directly - do all your rendering via the Graphics class instead. + + @tags{Graphics} */ class JUCE_API LowLevelGraphicsSoftwareRenderer : public RenderingHelpers::StackBasedLowLevelGraphicsContext { diff --git a/modules/juce_graphics/effects/juce_DropShadowEffect.h b/modules/juce_graphics/effects/juce_DropShadowEffect.h index 3de0f97a62..99a73e1d88 100644 --- a/modules/juce_graphics/effects/juce_DropShadowEffect.h +++ b/modules/juce_graphics/effects/juce_DropShadowEffect.h @@ -30,6 +30,8 @@ namespace juce //============================================================================== /** Defines a drop-shadow effect. + + @tags{Graphics} */ struct JUCE_API DropShadow { @@ -78,6 +80,8 @@ struct JUCE_API DropShadow shadow, check out ImageConvolutionKernel::createGaussianBlur() @see Component::setComponentEffect + + @tags{Graphics} */ class JUCE_API DropShadowEffect : public ImageEffectFilter { diff --git a/modules/juce_graphics/effects/juce_GlowEffect.h b/modules/juce_graphics/effects/juce_GlowEffect.h index 428ebad709..5fb80138c8 100644 --- a/modules/juce_graphics/effects/juce_GlowEffect.h +++ b/modules/juce_graphics/effects/juce_GlowEffect.h @@ -34,6 +34,8 @@ namespace juce (This will only work on non-opaque components). @see Component::setComponentEffect, DropShadowEffect + + @tags{Graphics} */ class JUCE_API GlowEffect : public ImageEffectFilter { diff --git a/modules/juce_graphics/effects/juce_ImageEffectFilter.h b/modules/juce_graphics/effects/juce_ImageEffectFilter.h index e06222d92c..a8e1891a24 100644 --- a/modules/juce_graphics/effects/juce_ImageEffectFilter.h +++ b/modules/juce_graphics/effects/juce_ImageEffectFilter.h @@ -37,6 +37,8 @@ namespace juce This is used for adding effects like shadows, blurs, etc. @see Component::setComponentEffect + + @tags{Graphics} */ class JUCE_API ImageEffectFilter { diff --git a/modules/juce_graphics/fonts/juce_AttributedString.h b/modules/juce_graphics/fonts/juce_AttributedString.h index f0cac6a062..7611df7873 100644 --- a/modules/juce_graphics/fonts/juce_AttributedString.h +++ b/modules/juce_graphics/fonts/juce_AttributedString.h @@ -36,6 +36,8 @@ namespace juce layout, etc., and draw it using AttributedString::draw(). @see TextLayout + + @tags{Graphics} */ class JUCE_API AttributedString { diff --git a/modules/juce_graphics/fonts/juce_CustomTypeface.h b/modules/juce_graphics/fonts/juce_CustomTypeface.h index 306e009c5c..4d8de59260 100644 --- a/modules/juce_graphics/fonts/juce_CustomTypeface.h +++ b/modules/juce_graphics/fonts/juce_CustomTypeface.h @@ -43,6 +43,8 @@ namespace juce and then call Typeface::createSystemTypefaceFor() to load it from memory. @see Typeface, Font + + @tags{Graphics} */ class JUCE_API CustomTypeface : public Typeface { diff --git a/modules/juce_graphics/fonts/juce_Font.h b/modules/juce_graphics/fonts/juce_Font.h index d869a237cf..91870c85ea 100644 --- a/modules/juce_graphics/fonts/juce_Font.h +++ b/modules/juce_graphics/fonts/juce_Font.h @@ -36,6 +36,8 @@ namespace juce horizontal scale factor. @see Typeface + + @tags{Graphics} */ class JUCE_API Font final { diff --git a/modules/juce_graphics/fonts/juce_GlyphArrangement.h b/modules/juce_graphics/fonts/juce_GlyphArrangement.h index d2f854c36b..62e727cbdc 100644 --- a/modules/juce_graphics/fonts/juce_GlyphArrangement.h +++ b/modules/juce_graphics/fonts/juce_GlyphArrangement.h @@ -36,6 +36,8 @@ namespace juce GlyphArrangement class will do what you need for text layout. @see GlyphArrangement, Font + + @tags{Graphics} */ class JUCE_API PositionedGlyph final { @@ -118,6 +120,8 @@ private: Graphics class, but can be used directly if more control is needed. @see Font, PositionedGlyph + + @tags{Graphics} */ class JUCE_API GlyphArrangement final { diff --git a/modules/juce_graphics/fonts/juce_TextLayout.h b/modules/juce_graphics/fonts/juce_TextLayout.h index 4b11eee20d..c8b253e57a 100644 --- a/modules/juce_graphics/fonts/juce_TextLayout.h +++ b/modules/juce_graphics/fonts/juce_TextLayout.h @@ -35,6 +35,8 @@ namespace juce quickly drawn into a Graphics context. @see AttributedString + + @tags{Graphics} */ class JUCE_API TextLayout final { diff --git a/modules/juce_graphics/fonts/juce_Typeface.h b/modules/juce_graphics/fonts/juce_Typeface.h index 95709b6f9c..8a8e042b37 100644 --- a/modules/juce_graphics/fonts/juce_Typeface.h +++ b/modules/juce_graphics/fonts/juce_Typeface.h @@ -41,6 +41,8 @@ namespace juce class does everything you typically need for rendering text. @see CustomTypeface, Font + + @tags{Graphics} */ class JUCE_API Typeface : public ReferenceCountedObject { diff --git a/modules/juce_graphics/geometry/juce_AffineTransform.h b/modules/juce_graphics/geometry/juce_AffineTransform.h index 6b3cd0125f..fbf12291bc 100644 --- a/modules/juce_graphics/geometry/juce_AffineTransform.h +++ b/modules/juce_graphics/geometry/juce_AffineTransform.h @@ -37,6 +37,8 @@ namespace juce These are used for various 2D transformation tasks, e.g. with Path objects. @see Path, Point, Line + + @tags{Graphics} */ class JUCE_API AffineTransform final { diff --git a/modules/juce_graphics/geometry/juce_BorderSize.h b/modules/juce_graphics/geometry/juce_BorderSize.h index 8678c2eb44..92a69cd926 100644 --- a/modules/juce_graphics/geometry/juce_BorderSize.h +++ b/modules/juce_graphics/geometry/juce_BorderSize.h @@ -35,6 +35,8 @@ namespace juce a rectangle. It's used by various component classes to specify borders. @see Rectangle + + @tags{Graphics} */ template class BorderSize diff --git a/modules/juce_graphics/geometry/juce_EdgeTable.h b/modules/juce_graphics/geometry/juce_EdgeTable.h index 50161fab50..071eb1c4c0 100644 --- a/modules/juce_graphics/geometry/juce_EdgeTable.h +++ b/modules/juce_graphics/geometry/juce_EdgeTable.h @@ -32,6 +32,8 @@ namespace juce A table of horizontal scan-line segments - used for rasterising Paths. @see Path, Graphics + + @tags{Graphics} */ class JUCE_API EdgeTable { diff --git a/modules/juce_graphics/geometry/juce_Line.h b/modules/juce_graphics/geometry/juce_Line.h index d8db97a4e6..fbe666ea0a 100644 --- a/modules/juce_graphics/geometry/juce_Line.h +++ b/modules/juce_graphics/geometry/juce_Line.h @@ -40,6 +40,8 @@ namespace juce sensible results. @see Point, Rectangle, Path, Graphics::drawLine + + @tags{Graphics} */ template class Line diff --git a/modules/juce_graphics/geometry/juce_Parallelogram.h b/modules/juce_graphics/geometry/juce_Parallelogram.h index 7e7fcd86c8..11541c3eef 100644 --- a/modules/juce_graphics/geometry/juce_Parallelogram.h +++ b/modules/juce_graphics/geometry/juce_Parallelogram.h @@ -31,6 +31,8 @@ namespace juce /** Represents a parallelogram that is defined by 3 points. @see Rectangle, Point, Line + + @tags{Graphics} */ template class Parallelogram diff --git a/modules/juce_graphics/geometry/juce_Path.h b/modules/juce_graphics/geometry/juce_Path.h index 969be61f11..4c58b743d2 100644 --- a/modules/juce_graphics/geometry/juce_Path.h +++ b/modules/juce_graphics/geometry/juce_Path.h @@ -59,6 +59,8 @@ namespace juce be open or closed. @see PathFlatteningIterator, PathStrokeType, Graphics + + @tags{Graphics} */ class JUCE_API Path final { diff --git a/modules/juce_graphics/geometry/juce_PathIterator.h b/modules/juce_graphics/geometry/juce_PathIterator.h index 3dff28b2d2..c1583b5255 100644 --- a/modules/juce_graphics/geometry/juce_PathIterator.h +++ b/modules/juce_graphics/geometry/juce_PathIterator.h @@ -36,6 +36,8 @@ namespace juce geometric operations on. @see Path + + @tags{Graphics} */ class JUCE_API PathFlatteningIterator final { diff --git a/modules/juce_graphics/geometry/juce_PathStrokeType.h b/modules/juce_graphics/geometry/juce_PathStrokeType.h index c84412dd98..b94b7af1fc 100644 --- a/modules/juce_graphics/geometry/juce_PathStrokeType.h +++ b/modules/juce_graphics/geometry/juce_PathStrokeType.h @@ -36,6 +36,8 @@ namespace juce stroke to draw. @see Path, Graphics::strokePath + + @tags{Graphics} */ class JUCE_API PathStrokeType { diff --git a/modules/juce_graphics/geometry/juce_Point.h b/modules/juce_graphics/geometry/juce_Point.h index b48ed9b053..e025f8b6db 100644 --- a/modules/juce_graphics/geometry/juce_Point.h +++ b/modules/juce_graphics/geometry/juce_Point.h @@ -35,6 +35,8 @@ namespace juce rather than a class. @see Line, Path, AffineTransform + + @tags{Graphics} */ template class Point diff --git a/modules/juce_graphics/geometry/juce_Rectangle.h b/modules/juce_graphics/geometry/juce_Rectangle.h index eb5d937be3..5792948ddd 100644 --- a/modules/juce_graphics/geometry/juce_Rectangle.h +++ b/modules/juce_graphics/geometry/juce_Rectangle.h @@ -32,6 +32,8 @@ namespace juce Manages a rectangle and allows geometric operations to be performed on it. @see RectangleList, Path, Line, Point + + @tags{Graphics} */ template class Rectangle diff --git a/modules/juce_graphics/geometry/juce_RectangleList.h b/modules/juce_graphics/geometry/juce_RectangleList.h index 893005aaeb..22091f9b10 100644 --- a/modules/juce_graphics/geometry/juce_RectangleList.h +++ b/modules/juce_graphics/geometry/juce_RectangleList.h @@ -36,6 +36,8 @@ namespace juce adjacent rectangles. @see Rectangle + + @tags{Graphics} */ template class RectangleList final diff --git a/modules/juce_graphics/images/juce_Image.h b/modules/juce_graphics/images/juce_Image.h index a017789d6e..c4e1c33ff4 100644 --- a/modules/juce_graphics/images/juce_Image.h +++ b/modules/juce_graphics/images/juce_Image.h @@ -52,6 +52,8 @@ class ImagePixelData; ImageFileFormat, which provides a way to load common image files. @see Graphics, ImageFileFormat, ImageCache, ImageConvolutionKernel + + @tags{Graphics} */ class JUCE_API Image final { @@ -437,6 +439,8 @@ private: ImagePixelData objects are created indirectly, by subclasses of ImageType. @see Image, ImageType + + @tags{Graphics} */ class JUCE_API ImagePixelData : public ReferenceCountedObject { @@ -470,6 +474,7 @@ public: NamedValueSet userData; //============================================================================== + /** Used to receive callbacks for image data changes */ struct Listener { virtual ~Listener() {} @@ -492,6 +497,8 @@ private: e.g. an in-memory bitmap, an OpenGL image, CoreGraphics image, etc. @see SoftwareImageType, NativeImageType, OpenGLImageType + + @tags{Graphics} */ class JUCE_API ImageType { @@ -516,6 +523,8 @@ public: /** An image storage type which holds the pixels in-memory as a simple block of values. @see ImageType, NativeImageType + + @tags{Graphics} */ class JUCE_API SoftwareImageType : public ImageType { @@ -532,6 +541,8 @@ public: An image storage type which holds the pixels using whatever is the default storage format on the current platform. @see ImageType, SoftwareImageType + + @tags{Graphics} */ class JUCE_API NativeImageType : public ImageType { diff --git a/modules/juce_graphics/images/juce_ImageCache.h b/modules/juce_graphics/images/juce_ImageCache.h index 753ce750de..99e4543e9a 100644 --- a/modules/juce_graphics/images/juce_ImageCache.h +++ b/modules/juce_graphics/images/juce_ImageCache.h @@ -41,6 +41,8 @@ namespace juce each time. @see Image, ImageFileFormat + + @tags{Graphics} */ class JUCE_API ImageCache { diff --git a/modules/juce_graphics/images/juce_ImageConvolutionKernel.h b/modules/juce_graphics/images/juce_ImageConvolutionKernel.h index c3495a2684..84369580d8 100644 --- a/modules/juce_graphics/images/juce_ImageConvolutionKernel.h +++ b/modules/juce_graphics/images/juce_ImageConvolutionKernel.h @@ -32,6 +32,8 @@ namespace juce Represents a filter kernel to use in convoluting an image. @see Image::applyConvolution + + @tags{Graphics} */ class JUCE_API ImageConvolutionKernel { diff --git a/modules/juce_graphics/images/juce_ImageFileFormat.h b/modules/juce_graphics/images/juce_ImageFileFormat.h index ec7138836a..4dda5c20c6 100644 --- a/modules/juce_graphics/images/juce_ImageFileFormat.h +++ b/modules/juce_graphics/images/juce_ImageFileFormat.h @@ -36,6 +36,8 @@ namespace juce from files, streams or from memory. @see Image, ImageCache + + @tags{Graphics} */ class JUCE_API ImageFileFormat { @@ -143,6 +145,8 @@ public: A subclass of ImageFileFormat for reading and writing PNG files. @see ImageFileFormat, JPEGImageFormat + + @tags{Graphics} */ class JUCE_API PNGImageFormat : public ImageFileFormat { @@ -165,6 +169,8 @@ public: A subclass of ImageFileFormat for reading and writing JPEG files. @see ImageFileFormat, PNGImageFormat + + @tags{Graphics} */ class JUCE_API JPEGImageFormat : public ImageFileFormat { @@ -197,6 +203,8 @@ private: A subclass of ImageFileFormat for reading GIF files. @see ImageFileFormat, PNGImageFormat, JPEGImageFormat + + @tags{Graphics} */ class JUCE_API GIFImageFormat : public ImageFileFormat { diff --git a/modules/juce_graphics/native/juce_RenderingHelpers.h b/modules/juce_graphics/native/juce_RenderingHelpers.h index 49eed381fb..f5d75c7c00 100644 --- a/modules/juce_graphics/native/juce_RenderingHelpers.h +++ b/modules/juce_graphics/native/juce_RenderingHelpers.h @@ -37,6 +37,8 @@ namespace RenderingHelpers //============================================================================== /** Holds either a simple integer translation, or an affine transform. + + @tags{Graphics} */ class TranslationOrTransform { @@ -141,7 +143,10 @@ public: }; //============================================================================== -/** Holds a cache of recently-used glyph objects of some type. */ +/** Holds a cache of recently-used glyph objects of some type. + + @tags{Graphics} +*/ template class GlyphCache : private DeletedAtShutdown { @@ -271,7 +276,10 @@ private: }; //============================================================================== -/** Caches a glyph as an edge-table. */ +/** Caches a glyph as an edge-table. + + @tags{Graphics} +*/ template class CachedGlyphEdgeTable : public ReferenceCountedObject { @@ -311,6 +319,8 @@ public: //============================================================================== /** Calculates the alpha values and positions for rendering the edges of a non-pixel-aligned rectangle. + + @tags{Graphics} */ struct FloatRectangleRasterisingInfo { diff --git a/modules/juce_graphics/placement/juce_Justification.h b/modules/juce_graphics/placement/juce_Justification.h index 8c8fb8362b..2da66ea492 100644 --- a/modules/juce_graphics/placement/juce_Justification.h +++ b/modules/juce_graphics/placement/juce_Justification.h @@ -35,6 +35,8 @@ namespace juce centred, etc. It is used in various places wherever this kind of information is needed. + + @tags{Graphics} */ class Justification { diff --git a/modules/juce_graphics/placement/juce_RectanglePlacement.h b/modules/juce_graphics/placement/juce_RectanglePlacement.h index 84eec1db0f..b6803d20d8 100644 --- a/modules/juce_graphics/placement/juce_RectanglePlacement.h +++ b/modules/juce_graphics/placement/juce_RectanglePlacement.h @@ -34,6 +34,8 @@ namespace juce Although similar to Justification, this is more specific, and has some extra options. + + @tags{Graphics} */ class JUCE_API RectanglePlacement { diff --git a/modules/juce_gui_basics/application/juce_Application.h b/modules/juce_gui_basics/application/juce_Application.h index 423f8ce5c6..792eec71a3 100644 --- a/modules/juce_gui_basics/application/juce_Application.h +++ b/modules/juce_gui_basics/application/juce_Application.h @@ -85,6 +85,8 @@ namespace juce @endcode @see JUCEApplicationBase, START_JUCE_APPLICATION + + @tags{GUI} */ class JUCE_API JUCEApplication : public JUCEApplicationBase, public ApplicationCommandTarget diff --git a/modules/juce_gui_basics/buttons/juce_ArrowButton.h b/modules/juce_gui_basics/buttons/juce_ArrowButton.h index 8ff4d7f476..600f82459c 100644 --- a/modules/juce_gui_basics/buttons/juce_ArrowButton.h +++ b/modules/juce_gui_basics/buttons/juce_ArrowButton.h @@ -32,6 +32,8 @@ namespace juce A button with an arrow in it. @see Button + + @tags{GUI} */ class JUCE_API ArrowButton : public Button { diff --git a/modules/juce_gui_basics/buttons/juce_Button.h b/modules/juce_gui_basics/buttons/juce_Button.h index 55c1c91e77..dc1fd00b08 100644 --- a/modules/juce_gui_basics/buttons/juce_Button.h +++ b/modules/juce_gui_basics/buttons/juce_Button.h @@ -36,6 +36,8 @@ namespace juce and radio groups, etc. @see TextButton, DrawableButton, ToggleButton + + @tags{GUI} */ class JUCE_API Button : public Component, public SettableTooltipClient diff --git a/modules/juce_gui_basics/buttons/juce_DrawableButton.h b/modules/juce_gui_basics/buttons/juce_DrawableButton.h index 8e261373c9..bd27f5a12d 100644 --- a/modules/juce_gui_basics/buttons/juce_DrawableButton.h +++ b/modules/juce_gui_basics/buttons/juce_DrawableButton.h @@ -35,6 +35,8 @@ namespace juce 'normal', 'over' and 'down' states. @see Button + + @tags{GUI} */ class JUCE_API DrawableButton : public Button { diff --git a/modules/juce_gui_basics/buttons/juce_HyperlinkButton.h b/modules/juce_gui_basics/buttons/juce_HyperlinkButton.h index 02d23d96aa..7ef418ad11 100644 --- a/modules/juce_gui_basics/buttons/juce_HyperlinkButton.h +++ b/modules/juce_gui_basics/buttons/juce_HyperlinkButton.h @@ -33,6 +33,8 @@ namespace juce when it's clicked. @see Button + + @tags{GUI} */ class JUCE_API HyperlinkButton : public Button { diff --git a/modules/juce_gui_basics/buttons/juce_ImageButton.h b/modules/juce_gui_basics/buttons/juce_ImageButton.h index c867973d7c..d7f90c5aa3 100644 --- a/modules/juce_gui_basics/buttons/juce_ImageButton.h +++ b/modules/juce_gui_basics/buttons/juce_ImageButton.h @@ -35,6 +35,8 @@ namespace juce button state changes. @see Button, ShapeButton, TextButton + + @tags{GUI} */ class JUCE_API ImageButton : public Button { diff --git a/modules/juce_gui_basics/buttons/juce_ShapeButton.h b/modules/juce_gui_basics/buttons/juce_ShapeButton.h index 193d886fd4..052bf95927 100644 --- a/modules/juce_gui_basics/buttons/juce_ShapeButton.h +++ b/modules/juce_gui_basics/buttons/juce_ShapeButton.h @@ -32,6 +32,8 @@ namespace juce A button that contains a filled shape. @see Button, ImageButton, TextButton, ArrowButton + + @tags{GUI} */ class JUCE_API ShapeButton : public Button { diff --git a/modules/juce_gui_basics/buttons/juce_TextButton.h b/modules/juce_gui_basics/buttons/juce_TextButton.h index 1631af52cb..27de419915 100644 --- a/modules/juce_gui_basics/buttons/juce_TextButton.h +++ b/modules/juce_gui_basics/buttons/juce_TextButton.h @@ -33,6 +33,8 @@ namespace juce text on it. @see Button, DrawableButton + + @tags{GUI} */ class JUCE_API TextButton : public Button { diff --git a/modules/juce_gui_basics/buttons/juce_ToggleButton.h b/modules/juce_gui_basics/buttons/juce_ToggleButton.h index afe3dcf2aa..a1d6e2db5d 100644 --- a/modules/juce_gui_basics/buttons/juce_ToggleButton.h +++ b/modules/juce_gui_basics/buttons/juce_ToggleButton.h @@ -35,6 +35,8 @@ namespace juce standard ones which has a tick-box and a text label next to it. @see Button, DrawableButton, TextButton + + @tags{GUI} */ class JUCE_API ToggleButton : public Button { diff --git a/modules/juce_gui_basics/buttons/juce_ToolbarButton.h b/modules/juce_gui_basics/buttons/juce_ToolbarButton.h index ce2190e038..08fe92d990 100644 --- a/modules/juce_gui_basics/buttons/juce_ToolbarButton.h +++ b/modules/juce_gui_basics/buttons/juce_ToolbarButton.h @@ -36,6 +36,8 @@ namespace juce toggle button. @see Toolbar, ToolbarItemFactory, ToolbarItemComponent, Drawable, Button + + @tags{GUI} */ class JUCE_API ToolbarButton : public ToolbarItemComponent { diff --git a/modules/juce_gui_basics/commands/juce_ApplicationCommandInfo.h b/modules/juce_gui_basics/commands/juce_ApplicationCommandInfo.h index 63358df6a5..0076a6dbd2 100644 --- a/modules/juce_gui_basics/commands/juce_ApplicationCommandInfo.h +++ b/modules/juce_gui_basics/commands/juce_ApplicationCommandInfo.h @@ -39,6 +39,8 @@ namespace juce @see ApplicationCommandTarget, ApplicationCommandTarget::getCommandInfo(), ApplicationCommandManager + + @tags{GUI} */ struct JUCE_API ApplicationCommandInfo { diff --git a/modules/juce_gui_basics/commands/juce_ApplicationCommandManager.h b/modules/juce_gui_basics/commands/juce_ApplicationCommandManager.h index 30c7cb98d9..e08ec2d039 100644 --- a/modules/juce_gui_basics/commands/juce_ApplicationCommandManager.h +++ b/modules/juce_gui_basics/commands/juce_ApplicationCommandManager.h @@ -81,6 +81,8 @@ namespace juce the object yourself. @see ApplicationCommandTarget, ApplicationCommandInfo + + @tags{GUI} */ class JUCE_API ApplicationCommandManager : private AsyncUpdater, private FocusChangeListener @@ -328,6 +330,8 @@ private: @see ApplicationCommandManager::addListener, ApplicationCommandManager::removeListener + + @tags{GUI} */ class JUCE_API ApplicationCommandManagerListener { diff --git a/modules/juce_gui_basics/commands/juce_ApplicationCommandTarget.h b/modules/juce_gui_basics/commands/juce_ApplicationCommandTarget.h index 1b31c1f64e..1de7620917 100644 --- a/modules/juce_gui_basics/commands/juce_ApplicationCommandTarget.h +++ b/modules/juce_gui_basics/commands/juce_ApplicationCommandTarget.h @@ -41,6 +41,8 @@ namespace juce ApplicationCommandManager::getFirstCommandTarget(). @see ApplicationCommandManager, ApplicationCommandInfo + + @tags{GUI} */ class JUCE_API ApplicationCommandTarget { diff --git a/modules/juce_gui_basics/commands/juce_KeyPressMappingSet.h b/modules/juce_gui_basics/commands/juce_KeyPressMappingSet.h index d850739bfa..43f9063fb1 100644 --- a/modules/juce_gui_basics/commands/juce_KeyPressMappingSet.h +++ b/modules/juce_gui_basics/commands/juce_KeyPressMappingSet.h @@ -81,6 +81,8 @@ namespace juce to easily edit the key mappings. @see Component::addKeyListener(), KeyMappingEditorComponent, ApplicationCommandManager + + @tags{GUI} */ class JUCE_API KeyPressMappingSet : public KeyListener, public ChangeBroadcaster, diff --git a/modules/juce_gui_basics/components/juce_CachedComponentImage.h b/modules/juce_gui_basics/components/juce_CachedComponentImage.h index 7e2b5485d7..2c1ab6ca1e 100644 --- a/modules/juce_gui_basics/components/juce_CachedComponentImage.h +++ b/modules/juce_gui_basics/components/juce_CachedComponentImage.h @@ -36,6 +36,8 @@ namespace juce only for power-users! @see Component::setCachedComponentImage + + @tags{GUI} */ class JUCE_API CachedComponentImage { diff --git a/modules/juce_gui_basics/components/juce_Component.h b/modules/juce_gui_basics/components/juce_Component.h index 44fe9c693b..cc4149d180 100644 --- a/modules/juce_gui_basics/components/juce_Component.h +++ b/modules/juce_gui_basics/components/juce_Component.h @@ -30,6 +30,8 @@ namespace juce //============================================================================== /** The base class for all JUCE user-interface objects. + + @tags{GUI} */ class JUCE_API Component : public MouseListener { diff --git a/modules/juce_gui_basics/components/juce_ComponentListener.h b/modules/juce_gui_basics/components/juce_ComponentListener.h index 3aa7c62b3e..8dc60a6500 100644 --- a/modules/juce_gui_basics/components/juce_ComponentListener.h +++ b/modules/juce_gui_basics/components/juce_ComponentListener.h @@ -37,6 +37,8 @@ namespace juce Be sure to deregister listeners before you delete them! @see Component::addComponentListener, Component::removeComponentListener + + @tags{GUI} */ class JUCE_API ComponentListener { diff --git a/modules/juce_gui_basics/components/juce_Desktop.h b/modules/juce_gui_basics/components/juce_Desktop.h index 4d7964ae14..8aac3ee599 100644 --- a/modules/juce_gui_basics/components/juce_Desktop.h +++ b/modules/juce_gui_basics/components/juce_Desktop.h @@ -33,6 +33,8 @@ namespace juce to receive callbacks when the currently focused component changes. @see Desktop::addFocusChangeListener, Desktop::removeFocusChangeListener + + @tags{GUI} */ class JUCE_API FocusChangeListener { @@ -49,6 +51,8 @@ public: /** Describes and controls aspects of the computer's desktop. + + @tags{GUI} */ class JUCE_API Desktop : private DeletedAtShutdown, private Timer, @@ -323,6 +327,7 @@ public: bool isOrientationEnabled (DisplayOrientation orientation) const noexcept; //============================================================================== + /** Manages details about connected display devices */ class JUCE_API Displays { public: diff --git a/modules/juce_gui_basics/components/juce_ModalComponentManager.h b/modules/juce_gui_basics/components/juce_ModalComponentManager.h index 55115987a6..b0f9315ff9 100644 --- a/modules/juce_gui_basics/components/juce_ModalComponentManager.h +++ b/modules/juce_gui_basics/components/juce_ModalComponentManager.h @@ -37,6 +37,8 @@ namespace juce @see Component::enterModalState, Component::exitModalState, Component::isCurrentlyModal, Component::getCurrentlyModalComponent, Component::isCurrentlyBlockedByAnotherModalComponent + + @tags{GUI} */ class JUCE_API ModalComponentManager : private AsyncUpdater, private DeletedAtShutdown @@ -156,6 +158,8 @@ private: /** This class provides some handy utility methods for creating ModalComponentManager::Callback objects that will invoke a static function with some parameters when a modal component is dismissed. + + @tags{GUI} */ class ModalCallbackFunction { diff --git a/modules/juce_gui_basics/drawables/juce_Drawable.h b/modules/juce_gui_basics/drawables/juce_Drawable.h index 44289584c2..a4172070a3 100644 --- a/modules/juce_gui_basics/drawables/juce_Drawable.h +++ b/modules/juce_gui_basics/drawables/juce_Drawable.h @@ -32,6 +32,8 @@ namespace juce The base class for objects which can draw themselves, e.g. polygons, images, etc. @see DrawableComposite, DrawableImage, DrawablePath, DrawableText + + @tags{GUI} */ class JUCE_API Drawable : public Component { diff --git a/modules/juce_gui_basics/drawables/juce_DrawableComposite.h b/modules/juce_gui_basics/drawables/juce_DrawableComposite.h index de0acec3ac..7e7ec89874 100644 --- a/modules/juce_gui_basics/drawables/juce_DrawableComposite.h +++ b/modules/juce_gui_basics/drawables/juce_DrawableComposite.h @@ -37,6 +37,8 @@ namespace juce Drawable objects. @see Drawable + + @tags{GUI} */ class JUCE_API DrawableComposite : public Drawable { diff --git a/modules/juce_gui_basics/drawables/juce_DrawableImage.h b/modules/juce_gui_basics/drawables/juce_DrawableImage.h index 6558517a76..6828d1ead7 100644 --- a/modules/juce_gui_basics/drawables/juce_DrawableImage.h +++ b/modules/juce_gui_basics/drawables/juce_DrawableImage.h @@ -32,6 +32,8 @@ namespace juce A drawable object which is a bitmap image. @see Drawable + + @tags{GUI} */ class JUCE_API DrawableImage : public Drawable { diff --git a/modules/juce_gui_basics/drawables/juce_DrawablePath.h b/modules/juce_gui_basics/drawables/juce_DrawablePath.h index d8b93363d2..ff54073282 100644 --- a/modules/juce_gui_basics/drawables/juce_DrawablePath.h +++ b/modules/juce_gui_basics/drawables/juce_DrawablePath.h @@ -34,6 +34,8 @@ namespace juce For details on how to change the fill and stroke, see the DrawableShape class. @see Drawable, DrawableShape + + @tags{GUI} */ class JUCE_API DrawablePath : public DrawableShape { diff --git a/modules/juce_gui_basics/drawables/juce_DrawableRectangle.h b/modules/juce_gui_basics/drawables/juce_DrawableRectangle.h index ab9fc46bee..a53d9b5519 100644 --- a/modules/juce_gui_basics/drawables/juce_DrawableRectangle.h +++ b/modules/juce_gui_basics/drawables/juce_DrawableRectangle.h @@ -34,6 +34,8 @@ namespace juce For details on how to change the fill and stroke, see the DrawableShape class. @see Drawable, DrawableShape + + @tags{GUI} */ class JUCE_API DrawableRectangle : public DrawableShape { diff --git a/modules/juce_gui_basics/drawables/juce_DrawableShape.h b/modules/juce_gui_basics/drawables/juce_DrawableShape.h index 64ba771bcb..70983ee805 100644 --- a/modules/juce_gui_basics/drawables/juce_DrawableShape.h +++ b/modules/juce_gui_basics/drawables/juce_DrawableShape.h @@ -33,6 +33,8 @@ namespace juce consist of some kind of filled and stroked outline. @see DrawablePath, DrawableRectangle + + @tags{GUI} */ class JUCE_API DrawableShape : public Drawable { diff --git a/modules/juce_gui_basics/drawables/juce_DrawableText.h b/modules/juce_gui_basics/drawables/juce_DrawableText.h index 801462efb2..498dc7cf18 100644 --- a/modules/juce_gui_basics/drawables/juce_DrawableText.h +++ b/modules/juce_gui_basics/drawables/juce_DrawableText.h @@ -32,6 +32,8 @@ namespace juce A drawable object which renders a line of text. @see Drawable + + @tags{GUI} */ class JUCE_API DrawableText : public Drawable { diff --git a/modules/juce_gui_basics/filebrowser/juce_ContentSharer.h b/modules/juce_gui_basics/filebrowser/juce_ContentSharer.h index fac378ee86..5da3972efb 100644 --- a/modules/juce_gui_basics/filebrowser/juce_ContentSharer.h +++ b/modules/juce_gui_basics/filebrowser/juce_ContentSharer.h @@ -32,6 +32,8 @@ namespace juce /** A singleton class responsible for sharing content between apps and devices. You can share text, images, files or an arbitrary data block. + + @tags{GUI} */ class JUCE_API ContentSharer { diff --git a/modules/juce_gui_basics/filebrowser/juce_DirectoryContentsDisplayComponent.h b/modules/juce_gui_basics/filebrowser/juce_DirectoryContentsDisplayComponent.h index 7fb4ef9373..7089b37f0e 100644 --- a/modules/juce_gui_basics/filebrowser/juce_DirectoryContentsDisplayComponent.h +++ b/modules/juce_gui_basics/filebrowser/juce_DirectoryContentsDisplayComponent.h @@ -32,6 +32,8 @@ namespace juce A base class for components that display a list of the files in a directory. @see DirectoryContentsList + + @tags{GUI} */ class JUCE_API DirectoryContentsDisplayComponent { diff --git a/modules/juce_gui_basics/filebrowser/juce_DirectoryContentsList.h b/modules/juce_gui_basics/filebrowser/juce_DirectoryContentsList.h index 3e717e9afe..20ce76f60d 100644 --- a/modules/juce_gui_basics/filebrowser/juce_DirectoryContentsList.h +++ b/modules/juce_gui_basics/filebrowser/juce_DirectoryContentsList.h @@ -36,6 +36,8 @@ namespace juce to tell any listeners. @see FileListComponent, FileBrowserComponent + + @tags{GUI} */ class JUCE_API DirectoryContentsList : public ChangeBroadcaster, private TimeSliceClient diff --git a/modules/juce_gui_basics/filebrowser/juce_FileBrowserComponent.h b/modules/juce_gui_basics/filebrowser/juce_FileBrowserComponent.h index 5c440eaca0..de338a6ca4 100644 --- a/modules/juce_gui_basics/filebrowser/juce_FileBrowserComponent.h +++ b/modules/juce_gui_basics/filebrowser/juce_FileBrowserComponent.h @@ -36,6 +36,8 @@ namespace juce be used for loading or saving a file, or for choosing a directory. @see FileChooserDialogBox, FileChooser, FileListComponent + + @tags{GUI} */ class JUCE_API FileBrowserComponent : public Component, private FileBrowserListener, diff --git a/modules/juce_gui_basics/filebrowser/juce_FileBrowserListener.h b/modules/juce_gui_basics/filebrowser/juce_FileBrowserListener.h index 45506a19d4..ef22c52334 100644 --- a/modules/juce_gui_basics/filebrowser/juce_FileBrowserListener.h +++ b/modules/juce_gui_basics/filebrowser/juce_FileBrowserListener.h @@ -32,6 +32,8 @@ namespace juce A listener for user selection events in a file browser. This is used by a FileBrowserComponent or FileListComponent. + + @tags{GUI} */ class JUCE_API FileBrowserListener { diff --git a/modules/juce_gui_basics/filebrowser/juce_FileChooser.h b/modules/juce_gui_basics/filebrowser/juce_FileChooser.h index cf32e57e6f..e07736923e 100644 --- a/modules/juce_gui_basics/filebrowser/juce_FileChooser.h +++ b/modules/juce_gui_basics/filebrowser/juce_FileChooser.h @@ -52,6 +52,8 @@ namespace juce } } @endcode + + @tags{GUI} */ class JUCE_API FileChooser { diff --git a/modules/juce_gui_basics/filebrowser/juce_FileChooserDialogBox.h b/modules/juce_gui_basics/filebrowser/juce_FileChooserDialogBox.h index 110547514e..16c006b8b9 100644 --- a/modules/juce_gui_basics/filebrowser/juce_FileChooserDialogBox.h +++ b/modules/juce_gui_basics/filebrowser/juce_FileChooserDialogBox.h @@ -61,6 +61,8 @@ namespace juce @endcode @see FileChooser + + @tags{GUI} */ class JUCE_API FileChooserDialogBox : public ResizableWindow, private FileBrowserListener diff --git a/modules/juce_gui_basics/filebrowser/juce_FileListComponent.h b/modules/juce_gui_basics/filebrowser/juce_FileListComponent.h index 55afdfc679..04bcab080e 100644 --- a/modules/juce_gui_basics/filebrowser/juce_FileListComponent.h +++ b/modules/juce_gui_basics/filebrowser/juce_FileListComponent.h @@ -38,6 +38,8 @@ namespace juce class and the FileBrowserListener class. @see DirectoryContentsList, FileTreeComponent + + @tags{GUI} */ class JUCE_API FileListComponent : public ListBox, public DirectoryContentsDisplayComponent, diff --git a/modules/juce_gui_basics/filebrowser/juce_FilePreviewComponent.h b/modules/juce_gui_basics/filebrowser/juce_FilePreviewComponent.h index 4781531371..c2220616be 100644 --- a/modules/juce_gui_basics/filebrowser/juce_FilePreviewComponent.h +++ b/modules/juce_gui_basics/filebrowser/juce_FilePreviewComponent.h @@ -38,6 +38,8 @@ namespace juce to allow it to update itself appropriately. @see FileChooser, ImagePreviewComponent + + @tags{GUI} */ class JUCE_API FilePreviewComponent : public Component { diff --git a/modules/juce_gui_basics/filebrowser/juce_FileSearchPathListComponent.h b/modules/juce_gui_basics/filebrowser/juce_FileSearchPathListComponent.h index 0a6e3cf0ed..32b87bc5cf 100644 --- a/modules/juce_gui_basics/filebrowser/juce_FileSearchPathListComponent.h +++ b/modules/juce_gui_basics/filebrowser/juce_FileSearchPathListComponent.h @@ -33,6 +33,8 @@ namespace juce re-ordered. @see FileSearchPath + + @tags{GUI} */ class JUCE_API FileSearchPathListComponent : public Component, public SettableTooltipClient, diff --git a/modules/juce_gui_basics/filebrowser/juce_FileTreeComponent.h b/modules/juce_gui_basics/filebrowser/juce_FileTreeComponent.h index 1a9a6cf2f3..998d08ed4a 100644 --- a/modules/juce_gui_basics/filebrowser/juce_FileTreeComponent.h +++ b/modules/juce_gui_basics/filebrowser/juce_FileTreeComponent.h @@ -38,6 +38,8 @@ namespace juce class and the FileBrowserListener class. @see DirectoryContentsList, FileListComponent + + @tags{GUI} */ class JUCE_API FileTreeComponent : public TreeView, public DirectoryContentsDisplayComponent diff --git a/modules/juce_gui_basics/filebrowser/juce_FilenameComponent.h b/modules/juce_gui_basics/filebrowser/juce_FilenameComponent.h index 3d7ae21fff..ce50b4e195 100644 --- a/modules/juce_gui_basics/filebrowser/juce_FilenameComponent.h +++ b/modules/juce_gui_basics/filebrowser/juce_FilenameComponent.h @@ -35,6 +35,8 @@ namespace juce register one of these objects for event callbacks when the filename is changed. @see FilenameComponent + + @tags{GUI} */ class JUCE_API FilenameComponentListener { @@ -60,6 +62,8 @@ public: and clicking 'ok', or by typing a new filename into the box and pressing return. @see FileChooser, ComboBox + + @tags{GUI} */ class JUCE_API FilenameComponent : public Component, public SettableTooltipClient, diff --git a/modules/juce_gui_basics/filebrowser/juce_ImagePreviewComponent.h b/modules/juce_gui_basics/filebrowser/juce_ImagePreviewComponent.h index df96266468..9b31e6693e 100644 --- a/modules/juce_gui_basics/filebrowser/juce_ImagePreviewComponent.h +++ b/modules/juce_gui_basics/filebrowser/juce_ImagePreviewComponent.h @@ -32,6 +32,8 @@ namespace juce A simple preview component that shows thumbnails of image files. @see FileChooserDialogBox, FilePreviewComponent + + @tags{GUI} */ class JUCE_API ImagePreviewComponent : public FilePreviewComponent, private Timer diff --git a/modules/juce_gui_basics/keyboard/juce_CaretComponent.h b/modules/juce_gui_basics/keyboard/juce_CaretComponent.h index b21cc7b5c3..2fb9394641 100644 --- a/modules/juce_gui_basics/keyboard/juce_CaretComponent.h +++ b/modules/juce_gui_basics/keyboard/juce_CaretComponent.h @@ -29,6 +29,8 @@ namespace juce //============================================================================== /** + + @tags{GUI} */ class JUCE_API CaretComponent : public Component, private Timer diff --git a/modules/juce_gui_basics/keyboard/juce_KeyListener.h b/modules/juce_gui_basics/keyboard/juce_KeyListener.h index f3cc762102..291cd66ae3 100644 --- a/modules/juce_gui_basics/keyboard/juce_KeyListener.h +++ b/modules/juce_gui_basics/keyboard/juce_KeyListener.h @@ -35,6 +35,8 @@ namespace juce gets key events. See the Component::addListener method for more details. @see KeyPress, Component::addKeyListener, KeyPressMappingSet + + @tags{GUI} */ class JUCE_API KeyListener { diff --git a/modules/juce_gui_basics/keyboard/juce_KeyPress.h b/modules/juce_gui_basics/keyboard/juce_KeyPress.h index 1dadf57ca4..81df0af7de 100644 --- a/modules/juce_gui_basics/keyboard/juce_KeyPress.h +++ b/modules/juce_gui_basics/keyboard/juce_KeyPress.h @@ -34,6 +34,8 @@ namespace juce E.g. a KeyPress might represent CTRL+C, SHIFT+ALT+H, Spacebar, Escape, etc. @see Component, KeyListener, KeyPressMappingSet, Button::addShortcut + + @tags{GUI} */ class JUCE_API KeyPress { diff --git a/modules/juce_gui_basics/keyboard/juce_KeyboardFocusTraverser.h b/modules/juce_gui_basics/keyboard/juce_KeyboardFocusTraverser.h index c6d88f0c48..a92bcc8f31 100644 --- a/modules/juce_gui_basics/keyboard/juce_KeyboardFocusTraverser.h +++ b/modules/juce_gui_basics/keyboard/juce_KeyboardFocusTraverser.h @@ -46,6 +46,8 @@ namespace juce Component::createFocusTraverser() to create it. @see Component::setExplicitFocusOrder, Component::createFocusTraverser + + @tags{GUI} */ class JUCE_API KeyboardFocusTraverser { diff --git a/modules/juce_gui_basics/keyboard/juce_ModifierKeys.h b/modules/juce_gui_basics/keyboard/juce_ModifierKeys.h index 61c02604b3..951503101f 100644 --- a/modules/juce_gui_basics/keyboard/juce_ModifierKeys.h +++ b/modules/juce_gui_basics/keyboard/juce_ModifierKeys.h @@ -35,6 +35,8 @@ namespace juce the state of keys such as shift, control, alt, etc. @see KeyPress, MouseEvent::mods + + @tags{GUI} */ class JUCE_API ModifierKeys { diff --git a/modules/juce_gui_basics/keyboard/juce_SystemClipboard.h b/modules/juce_gui_basics/keyboard/juce_SystemClipboard.h index b00135dbaf..0cf97cd98e 100644 --- a/modules/juce_gui_basics/keyboard/juce_SystemClipboard.h +++ b/modules/juce_gui_basics/keyboard/juce_SystemClipboard.h @@ -30,6 +30,8 @@ namespace juce //============================================================================== /** Handles reading/writing to the system's clipboard. + + @tags{GUI} */ class JUCE_API SystemClipboard { diff --git a/modules/juce_gui_basics/keyboard/juce_TextEditorKeyMapper.h b/modules/juce_gui_basics/keyboard/juce_TextEditorKeyMapper.h index 30c5a9b1a1..0c9789a155 100644 --- a/modules/juce_gui_basics/keyboard/juce_TextEditorKeyMapper.h +++ b/modules/juce_gui_basics/keyboard/juce_TextEditorKeyMapper.h @@ -32,6 +32,8 @@ namespace juce an object, based upon a keypress event. It's currently used internally by the TextEditor and CodeEditorComponent. + + @tags{GUI} */ template struct TextEditorKeyMapper diff --git a/modules/juce_gui_basics/keyboard/juce_TextInputTarget.h b/modules/juce_gui_basics/keyboard/juce_TextInputTarget.h index 44b28c261e..0e3127474a 100644 --- a/modules/juce_gui_basics/keyboard/juce_TextInputTarget.h +++ b/modules/juce_gui_basics/keyboard/juce_TextInputTarget.h @@ -35,6 +35,8 @@ namespace juce This class allows different types of text editor component to provide a uniform interface, which can be used by things like OS-specific input methods, on-screen keyboards, etc. + + @tags{GUI} */ class JUCE_API TextInputTarget { diff --git a/modules/juce_gui_basics/layout/juce_AnimatedPosition.h b/modules/juce_gui_basics/layout/juce_AnimatedPosition.h index dccf55df2a..18915ed8e7 100644 --- a/modules/juce_gui_basics/layout/juce_AnimatedPosition.h +++ b/modules/juce_gui_basics/layout/juce_AnimatedPosition.h @@ -47,6 +47,8 @@ namespace juce @see AnimatedPositionBehaviours::ContinuousWithMomentum, AnimatedPositionBehaviours::SnapToPageBoundaries + + @tags{GUI} */ template class AnimatedPosition : private Timer diff --git a/modules/juce_gui_basics/layout/juce_AnimatedPositionBehaviours.h b/modules/juce_gui_basics/layout/juce_AnimatedPositionBehaviours.h index 3be77da9be..bdf8255b8a 100644 --- a/modules/juce_gui_basics/layout/juce_AnimatedPositionBehaviours.h +++ b/modules/juce_gui_basics/layout/juce_AnimatedPositionBehaviours.h @@ -41,6 +41,8 @@ namespace AnimatedPositionBehaviours AnimatedPosition class. @see AnimatedPosition + + @tags{GUI} */ struct ContinuousWithMomentum { @@ -107,6 +109,8 @@ namespace AnimatedPositionBehaviours released, snaps back to show a whole page. @see AnimatedPosition + + @tags{GUI} */ struct SnapToPageBoundaries { diff --git a/modules/juce_gui_basics/layout/juce_ComponentAnimator.h b/modules/juce_gui_basics/layout/juce_ComponentAnimator.h index 85fdb1e775..054a518662 100644 --- a/modules/juce_gui_basics/layout/juce_ComponentAnimator.h +++ b/modules/juce_gui_basics/layout/juce_ComponentAnimator.h @@ -47,6 +47,8 @@ namespace juce start or finish being animated. @see Desktop::getAnimator + + @tags{GUI} */ class JUCE_API ComponentAnimator : public ChangeBroadcaster, private Timer diff --git a/modules/juce_gui_basics/layout/juce_ComponentBoundsConstrainer.h b/modules/juce_gui_basics/layout/juce_ComponentBoundsConstrainer.h index 16b8a44269..50633698fa 100644 --- a/modules/juce_gui_basics/layout/juce_ComponentBoundsConstrainer.h +++ b/modules/juce_gui_basics/layout/juce_ComponentBoundsConstrainer.h @@ -38,6 +38,8 @@ namespace juce also subclass this for custom uses. @see ResizableCornerComponent, ResizableBorderComponent, ResizableWindow + + @tags{GUI} */ class JUCE_API ComponentBoundsConstrainer { diff --git a/modules/juce_gui_basics/layout/juce_ComponentBuilder.h b/modules/juce_gui_basics/layout/juce_ComponentBuilder.h index 8d8d7debfd..3fd09041a5 100644 --- a/modules/juce_gui_basics/layout/juce_ComponentBuilder.h +++ b/modules/juce_gui_basics/layout/juce_ComponentBuilder.h @@ -42,6 +42,8 @@ namespace juce Once you've got the component you can either take it and delete the ComponentBuilder object, or if you keep the ComponentBuilder around, it'll monitor any changes in the ValueTree and automatically update the component to reflect these changes. + + @tags{GUI} */ class JUCE_API ComponentBuilder : private ValueTree::Listener { diff --git a/modules/juce_gui_basics/layout/juce_ComponentMovementWatcher.h b/modules/juce_gui_basics/layout/juce_ComponentMovementWatcher.h index c425ab36e5..8f4bbb1515 100644 --- a/modules/juce_gui_basics/layout/juce_ComponentMovementWatcher.h +++ b/modules/juce_gui_basics/layout/juce_ComponentMovementWatcher.h @@ -41,6 +41,8 @@ namespace juce This class is used by specialised components like WebBrowserComponent because they need to keep their custom windows in the right place and respond to changes in the peer. + + @tags{GUI} */ class JUCE_API ComponentMovementWatcher : public ComponentListener { diff --git a/modules/juce_gui_basics/layout/juce_ConcertinaPanel.h b/modules/juce_gui_basics/layout/juce_ConcertinaPanel.h index aea9dbff62..eae4e5497d 100644 --- a/modules/juce_gui_basics/layout/juce_ConcertinaPanel.h +++ b/modules/juce_gui_basics/layout/juce_ConcertinaPanel.h @@ -34,6 +34,8 @@ namespace juce Each section has its own header bar which can be dragged up and down to resize it, or double-clicked to fully expand that section. + + @tags{GUI} */ class JUCE_API ConcertinaPanel : public Component { diff --git a/modules/juce_gui_basics/layout/juce_FlexBox.h b/modules/juce_gui_basics/layout/juce_FlexBox.h index 6ca40b9ba4..4fc090e036 100644 --- a/modules/juce_gui_basics/layout/juce_FlexBox.h +++ b/modules/juce_gui_basics/layout/juce_FlexBox.h @@ -37,6 +37,8 @@ namespace juce Component. @see FlexItem + + @tags{GUI} */ class JUCE_API FlexBox final { diff --git a/modules/juce_gui_basics/layout/juce_FlexItem.h b/modules/juce_gui_basics/layout/juce_FlexItem.h index 113ab339c8..7b625aa5f6 100644 --- a/modules/juce_gui_basics/layout/juce_FlexItem.h +++ b/modules/juce_gui_basics/layout/juce_FlexItem.h @@ -31,6 +31,8 @@ namespace juce Describes the properties of an item inside a FlexBox container. @see FlexBox + + @tags{GUI} */ class JUCE_API FlexItem final { diff --git a/modules/juce_gui_basics/layout/juce_Grid.h b/modules/juce_gui_basics/layout/juce_Grid.h index 6170ed99b7..86e87719ad 100644 --- a/modules/juce_gui_basics/layout/juce_Grid.h +++ b/modules/juce_gui_basics/layout/juce_Grid.h @@ -34,6 +34,8 @@ namespace juce https://css-tricks.com/snippets/css/complete-guide-grid/ @see GridItem + + @tags{GUI} */ class JUCE_API Grid final { diff --git a/modules/juce_gui_basics/layout/juce_GridItem.h b/modules/juce_gui_basics/layout/juce_GridItem.h index 748fe1c43c..30f95c6e32 100644 --- a/modules/juce_gui_basics/layout/juce_GridItem.h +++ b/modules/juce_gui_basics/layout/juce_GridItem.h @@ -30,6 +30,8 @@ namespace juce /** Defines an item in a Grid @see Grid + + @tags{GUI} */ class JUCE_API GridItem { diff --git a/modules/juce_gui_basics/layout/juce_GroupComponent.h b/modules/juce_gui_basics/layout/juce_GroupComponent.h index 47ef9245db..46c3b6923d 100644 --- a/modules/juce_gui_basics/layout/juce_GroupComponent.h +++ b/modules/juce_gui_basics/layout/juce_GroupComponent.h @@ -32,6 +32,8 @@ namespace juce A component that draws an outline around itself and has an optional title at the top, for drawing an outline around a group of controls. + + @tags{GUI} */ class JUCE_API GroupComponent : public Component { diff --git a/modules/juce_gui_basics/layout/juce_MultiDocumentPanel.h b/modules/juce_gui_basics/layout/juce_MultiDocumentPanel.h index 461470da32..b848c478af 100644 --- a/modules/juce_gui_basics/layout/juce_MultiDocumentPanel.h +++ b/modules/juce_gui_basics/layout/juce_MultiDocumentPanel.h @@ -39,6 +39,8 @@ class MultiDocumentPanel; everything works nicely inside a MultiDocumentPanel. @see MultiDocumentPanel + + @tags{GUI} */ class JUCE_API MultiDocumentPanelWindow : public DocumentWindow { @@ -81,6 +83,8 @@ private: Use addDocument() and closeDocument() to add or remove components from the panel - never use any of the Component methods to access the panel's child components directly, as these are managed internally. + + @tags{GUI} */ class JUCE_API MultiDocumentPanel : public Component, private ComponentListener diff --git a/modules/juce_gui_basics/layout/juce_ResizableBorderComponent.h b/modules/juce_gui_basics/layout/juce_ResizableBorderComponent.h index 53ec37e166..507dd17718 100644 --- a/modules/juce_gui_basics/layout/juce_ResizableBorderComponent.h +++ b/modules/juce_gui_basics/layout/juce_ResizableBorderComponent.h @@ -42,6 +42,8 @@ namespace juce each time the parent's size changes. @see ResizableCornerComponent + + @tags{GUI} */ class JUCE_API ResizableBorderComponent : public Component { diff --git a/modules/juce_gui_basics/layout/juce_ResizableCornerComponent.h b/modules/juce_gui_basics/layout/juce_ResizableCornerComponent.h index ae1f8264c9..e8754666c7 100644 --- a/modules/juce_gui_basics/layout/juce_ResizableCornerComponent.h +++ b/modules/juce_gui_basics/layout/juce_ResizableCornerComponent.h @@ -36,6 +36,8 @@ namespace juce around. @see ResizableBorderComponent + + @tags{GUI} */ class JUCE_API ResizableCornerComponent : public Component { diff --git a/modules/juce_gui_basics/layout/juce_ResizableEdgeComponent.h b/modules/juce_gui_basics/layout/juce_ResizableEdgeComponent.h index 2063375c8f..757d7bca1e 100644 --- a/modules/juce_gui_basics/layout/juce_ResizableEdgeComponent.h +++ b/modules/juce_gui_basics/layout/juce_ResizableEdgeComponent.h @@ -39,6 +39,8 @@ namespace juce changes, to keep it in the correct position. @see ResizbleBorderComponent, ResizableCornerComponent + + @tags{GUI} */ class JUCE_API ResizableEdgeComponent : public Component { diff --git a/modules/juce_gui_basics/layout/juce_ScrollBar.h b/modules/juce_gui_basics/layout/juce_ScrollBar.h index 4263e668d7..53118bd398 100644 --- a/modules/juce_gui_basics/layout/juce_ScrollBar.h +++ b/modules/juce_gui_basics/layout/juce_ScrollBar.h @@ -46,6 +46,8 @@ namespace juce instead of handling a scrollbar directly. @see ScrollBar::Listener + + @tags{GUI} */ class JUCE_API ScrollBar : public Component, public AsyncUpdater, diff --git a/modules/juce_gui_basics/layout/juce_SidePanel.h b/modules/juce_gui_basics/layout/juce_SidePanel.h index 2f16f2d9d7..510235cdf0 100644 --- a/modules/juce_gui_basics/layout/juce_SidePanel.h +++ b/modules/juce_gui_basics/layout/juce_SidePanel.h @@ -36,8 +36,9 @@ namespace juce When triggered with the showOrHide() method, the SidePanel will animate itself to its new position. This component also contains some logic to reactively resize and dismiss itself when the user drags it. - */ -//============================================================================== + + @tags{GUI} +*/ class SidePanel : public Component, private ComponentListener { diff --git a/modules/juce_gui_basics/layout/juce_StretchableLayoutManager.h b/modules/juce_gui_basics/layout/juce_StretchableLayoutManager.h index 4a5468a378..32f10b19a3 100644 --- a/modules/juce_gui_basics/layout/juce_StretchableLayoutManager.h +++ b/modules/juce_gui_basics/layout/juce_StretchableLayoutManager.h @@ -77,6 +77,8 @@ namespace juce @endcode @see StretchableLayoutResizerBar + + @tags{GUI} */ class JUCE_API StretchableLayoutManager { diff --git a/modules/juce_gui_basics/layout/juce_StretchableLayoutResizerBar.h b/modules/juce_gui_basics/layout/juce_StretchableLayoutResizerBar.h index e1a20509f8..9b087580a2 100644 --- a/modules/juce_gui_basics/layout/juce_StretchableLayoutResizerBar.h +++ b/modules/juce_gui_basics/layout/juce_StretchableLayoutResizerBar.h @@ -35,6 +35,8 @@ namespace juce One of these acts with a StretchableLayoutManager to resize the other components. @see StretchableLayoutManager + + @tags{GUI} */ class JUCE_API StretchableLayoutResizerBar : public Component { diff --git a/modules/juce_gui_basics/layout/juce_StretchableObjectResizer.h b/modules/juce_gui_basics/layout/juce_StretchableObjectResizer.h index 2dbbf106c3..fe23771b88 100644 --- a/modules/juce_gui_basics/layout/juce_StretchableObjectResizer.h +++ b/modules/juce_gui_basics/layout/juce_StretchableObjectResizer.h @@ -41,6 +41,8 @@ namespace juce It's currently used by the TableHeaderComponent for stretching out the table headings to fill the table's width. + + @tags{GUI} */ class StretchableObjectResizer { diff --git a/modules/juce_gui_basics/layout/juce_TabbedButtonBar.h b/modules/juce_gui_basics/layout/juce_TabbedButtonBar.h index 3296010efd..d3c9a167a0 100644 --- a/modules/juce_gui_basics/layout/juce_TabbedButtonBar.h +++ b/modules/juce_gui_basics/layout/juce_TabbedButtonBar.h @@ -38,6 +38,8 @@ class TabbedButtonBar; method to create it instead of the default one. @see TabbedButtonBar + + @tags{GUI} */ class JUCE_API TabBarButton : public Button { @@ -145,6 +147,8 @@ private: and other housekeeping. @see TabbedComponent + + @tags{GUI} */ class JUCE_API TabbedButtonBar : public Component, public ChangeBroadcaster diff --git a/modules/juce_gui_basics/layout/juce_TabbedComponent.h b/modules/juce_gui_basics/layout/juce_TabbedComponent.h index 6ba317440b..ec0ba1b942 100644 --- a/modules/juce_gui_basics/layout/juce_TabbedComponent.h +++ b/modules/juce_gui_basics/layout/juce_TabbedComponent.h @@ -36,6 +36,8 @@ namespace juce user clicks on a different tab. @see TabbedButtonBar + + @tags{GUI} */ class JUCE_API TabbedComponent : public Component { diff --git a/modules/juce_gui_basics/layout/juce_Viewport.h b/modules/juce_gui_basics/layout/juce_Viewport.h index 248e47396b..529e3beaba 100644 --- a/modules/juce_gui_basics/layout/juce_Viewport.h +++ b/modules/juce_gui_basics/layout/juce_Viewport.h @@ -39,6 +39,8 @@ namespace juce A subclass of the viewport can be created which will receive calls to its visibleAreaChanged() method when the subcomponent changes position or size. + + @tags{GUI} */ class JUCE_API Viewport : public Component, private ComponentListener, diff --git a/modules/juce_gui_basics/lookandfeel/juce_LookAndFeel.h b/modules/juce_gui_basics/lookandfeel/juce_LookAndFeel.h index 5d0879b266..a9ddb9ee00 100644 --- a/modules/juce_gui_basics/lookandfeel/juce_LookAndFeel.h +++ b/modules/juce_gui_basics/lookandfeel/juce_LookAndFeel.h @@ -31,6 +31,8 @@ namespace juce /** This class is used to hold a few look and feel base classes which are associated with classes that may not be present because they're from modules other than juce_gui_basics. + + @tags{GUI} */ struct JUCE_API ExtraLookAndFeelBaseClasses { @@ -72,6 +74,8 @@ struct JUCE_API ExtraLookAndFeelBaseClasses instantiate, see LookAndFeel_V1, LookAndFeel_V2 and LookAndFeel_V3. @see LookAndFeel_V1, LookAndFeel_V2, LookAndFeel_V3 + + @tags{GUI} */ class JUCE_API LookAndFeel : public ScrollBar::LookAndFeelMethods, public Button::LookAndFeelMethods, diff --git a/modules/juce_gui_basics/lookandfeel/juce_LookAndFeel_V1.h b/modules/juce_gui_basics/lookandfeel/juce_LookAndFeel_V1.h index 45950042d1..004872c7c8 100644 --- a/modules/juce_gui_basics/lookandfeel/juce_LookAndFeel_V1.h +++ b/modules/juce_gui_basics/lookandfeel/juce_LookAndFeel_V1.h @@ -31,6 +31,8 @@ namespace juce /** The original JUCE look-and-feel, as used back from 2002 to about 2007ish. @see LookAndFeel, LookAndFeel_V2, LookAndFeel_V3 + + @tags{GUI} */ class JUCE_API LookAndFeel_V1 : public LookAndFeel_V2 { diff --git a/modules/juce_gui_basics/lookandfeel/juce_LookAndFeel_V2.h b/modules/juce_gui_basics/lookandfeel/juce_LookAndFeel_V2.h index d912b89d7f..805e1af0e5 100644 --- a/modules/juce_gui_basics/lookandfeel/juce_LookAndFeel_V2.h +++ b/modules/juce_gui_basics/lookandfeel/juce_LookAndFeel_V2.h @@ -32,6 +32,8 @@ namespace juce This LookAndFeel subclass implements the juce style from around 2008-12. @see LookAndFeel, LookAndFeel_V1, LookAndFeel_V3 + + @tags{GUI} */ class JUCE_API LookAndFeel_V2 : public LookAndFeel { diff --git a/modules/juce_gui_basics/lookandfeel/juce_LookAndFeel_V3.h b/modules/juce_gui_basics/lookandfeel/juce_LookAndFeel_V3.h index 7a3bdcb4d8..6d48a798f3 100644 --- a/modules/juce_gui_basics/lookandfeel/juce_LookAndFeel_V3.h +++ b/modules/juce_gui_basics/lookandfeel/juce_LookAndFeel_V3.h @@ -31,6 +31,8 @@ namespace juce /** The latest JUCE look-and-feel style, as introduced in 2013. @see LookAndFeel, LookAndFeel_V1, LookAndFeel_V2 + + @tags{GUI} */ class JUCE_API LookAndFeel_V3 : public LookAndFeel_V2 { diff --git a/modules/juce_gui_basics/lookandfeel/juce_LookAndFeel_V4.h b/modules/juce_gui_basics/lookandfeel/juce_LookAndFeel_V4.h index 73db5422a3..e83990dbb8 100644 --- a/modules/juce_gui_basics/lookandfeel/juce_LookAndFeel_V4.h +++ b/modules/juce_gui_basics/lookandfeel/juce_LookAndFeel_V4.h @@ -31,6 +31,8 @@ namespace juce /** The latest JUCE look-and-feel style, as introduced in 2017. @see LookAndFeel, LookAndFeel_V1, LookAndFeel_V2, LookAndFeel_V3 + + @tags{GUI} */ class JUCE_API LookAndFeel_V4 : public LookAndFeel_V3 { diff --git a/modules/juce_gui_basics/menus/juce_BurgerMenuComponent.h b/modules/juce_gui_basics/menus/juce_BurgerMenuComponent.h index 63c65259b3..8b36e8d664 100644 --- a/modules/juce_gui_basics/menus/juce_BurgerMenuComponent.h +++ b/modules/juce_gui_basics/menus/juce_BurgerMenuComponent.h @@ -34,8 +34,9 @@ namespace juce for so-called "burger" menus in mobile apps. @see MenuBarModel + + @tags{GUI} */ -//============================================================================== class BurgerMenuComponent : public Component, private ListBoxModel, private MenuBarModel::Listener diff --git a/modules/juce_gui_basics/menus/juce_MenuBarComponent.h b/modules/juce_gui_basics/menus/juce_MenuBarComponent.h index 82f9a4e089..190384a19f 100644 --- a/modules/juce_gui_basics/menus/juce_MenuBarComponent.h +++ b/modules/juce_gui_basics/menus/juce_MenuBarComponent.h @@ -32,6 +32,8 @@ namespace juce A menu bar component. @see MenuBarModel + + @tags{GUI} */ class JUCE_API MenuBarComponent : public Component, private MenuBarModel::Listener, diff --git a/modules/juce_gui_basics/menus/juce_MenuBarModel.h b/modules/juce_gui_basics/menus/juce_MenuBarModel.h index bcf2bfe949..792337d1f0 100644 --- a/modules/juce_gui_basics/menus/juce_MenuBarModel.h +++ b/modules/juce_gui_basics/menus/juce_MenuBarModel.h @@ -35,6 +35,8 @@ namespace juce to a menu being selected. @see MenuBarModel::Listener, MenuBarComponent, PopupMenu + + @tags{GUI} */ class JUCE_API MenuBarModel : private AsyncUpdater, private ApplicationCommandManagerListener diff --git a/modules/juce_gui_basics/menus/juce_PopupMenu.h b/modules/juce_gui_basics/menus/juce_PopupMenu.h index 2c149c9fd2..fefe2e3180 100644 --- a/modules/juce_gui_basics/menus/juce_PopupMenu.h +++ b/modules/juce_gui_basics/menus/juce_PopupMenu.h @@ -74,6 +74,8 @@ namespace juce ...etc } @endcode + + @tags{GUI} */ class JUCE_API PopupMenu { diff --git a/modules/juce_gui_basics/misc/juce_BubbleComponent.h b/modules/juce_gui_basics/misc/juce_BubbleComponent.h index fe253274fc..1026143e71 100644 --- a/modules/juce_gui_basics/misc/juce_BubbleComponent.h +++ b/modules/juce_gui_basics/misc/juce_BubbleComponent.h @@ -41,6 +41,8 @@ namespace juce resize and position it, then make it visible. @see BubbleMessageComponent + + @tags{GUI} */ class JUCE_API BubbleComponent : public Component { diff --git a/modules/juce_gui_basics/misc/juce_DropShadower.h b/modules/juce_gui_basics/misc/juce_DropShadower.h index 9137609869..633a9ae26c 100644 --- a/modules/juce_gui_basics/misc/juce_DropShadower.h +++ b/modules/juce_gui_basics/misc/juce_DropShadower.h @@ -40,6 +40,8 @@ namespace juce set the Component::windowHasDropShadow flag when calling Component::addToDesktop(), and the system will create one of these if it's needed (which it obviously isn't on the Mac, for example). + + @tags{GUI} */ class JUCE_API DropShadower : private ComponentListener { diff --git a/modules/juce_gui_basics/misc/juce_JUCESplashScreen.h b/modules/juce_gui_basics/misc/juce_JUCESplashScreen.h index 4452458827..5f9b04bc23 100644 --- a/modules/juce_gui_basics/misc/juce_JUCESplashScreen.h +++ b/modules/juce_gui_basics/misc/juce_JUCESplashScreen.h @@ -44,6 +44,8 @@ namespace juce /** The standard JUCE splash screen component. + + @tags{GUI} */ class JUCE_API JUCESplashScreen : public Component, private Timer, diff --git a/modules/juce_gui_basics/mouse/juce_ComponentDragger.h b/modules/juce_gui_basics/mouse/juce_ComponentDragger.h index dedf284f7e..eec0c5b204 100644 --- a/modules/juce_gui_basics/mouse/juce_ComponentDragger.h +++ b/modules/juce_gui_basics/mouse/juce_ComponentDragger.h @@ -53,6 +53,8 @@ namespace juce } }; @endcode + + @tags{GUI} */ class JUCE_API ComponentDragger { diff --git a/modules/juce_gui_basics/mouse/juce_DragAndDropContainer.h b/modules/juce_gui_basics/mouse/juce_DragAndDropContainer.h index eef04a382e..631f878e91 100644 --- a/modules/juce_gui_basics/mouse/juce_DragAndDropContainer.h +++ b/modules/juce_gui_basics/mouse/juce_DragAndDropContainer.h @@ -45,6 +45,8 @@ namespace juce simply by overriding FileDragAndDropTarget::filesDropped(). @see DragAndDropTarget + + @tags{GUI} */ class JUCE_API DragAndDropContainer { diff --git a/modules/juce_gui_basics/mouse/juce_DragAndDropTarget.h b/modules/juce_gui_basics/mouse/juce_DragAndDropTarget.h index b7be4d4868..11d72dbc3a 100644 --- a/modules/juce_gui_basics/mouse/juce_DragAndDropTarget.h +++ b/modules/juce_gui_basics/mouse/juce_DragAndDropTarget.h @@ -40,6 +40,8 @@ namespace juce see the FileDragAndDropTarget class. @see DragAndDropContainer, FileDragAndDropTarget + + @tags{GUI} */ class JUCE_API DragAndDropTarget { diff --git a/modules/juce_gui_basics/mouse/juce_FileDragAndDropTarget.h b/modules/juce_gui_basics/mouse/juce_FileDragAndDropTarget.h index e6491dcce5..0367e4c131 100644 --- a/modules/juce_gui_basics/mouse/juce_FileDragAndDropTarget.h +++ b/modules/juce_gui_basics/mouse/juce_FileDragAndDropTarget.h @@ -31,6 +31,8 @@ namespace juce Components derived from this class can have files dropped onto them by an external application. @see DragAndDropContainer + + @tags{GUI} */ class JUCE_API FileDragAndDropTarget { diff --git a/modules/juce_gui_basics/mouse/juce_LassoComponent.h b/modules/juce_gui_basics/mouse/juce_LassoComponent.h index 2b0bda4dd3..9c6349aab4 100644 --- a/modules/juce_gui_basics/mouse/juce_LassoComponent.h +++ b/modules/juce_gui_basics/mouse/juce_LassoComponent.h @@ -35,6 +35,8 @@ namespace juce and to change the list of selected items. @see LassoComponent, SelectedItemSet + + @tags{GUI} */ template class LassoSource @@ -92,6 +94,8 @@ public: xor'ed with any previously selected items. @see LassoSource, SelectedItemSet + + @tags{GUI} */ template class LassoComponent : public Component diff --git a/modules/juce_gui_basics/mouse/juce_MouseCursor.h b/modules/juce_gui_basics/mouse/juce_MouseCursor.h index 4f3a483623..f904a39836 100644 --- a/modules/juce_gui_basics/mouse/juce_MouseCursor.h +++ b/modules/juce_gui_basics/mouse/juce_MouseCursor.h @@ -33,6 +33,8 @@ namespace juce This object can either be used to represent one of the standard mouse cursor shapes, or a custom one generated from an image. + + @tags{GUI} */ class JUCE_API MouseCursor final { diff --git a/modules/juce_gui_basics/mouse/juce_MouseEvent.h b/modules/juce_gui_basics/mouse/juce_MouseEvent.h index 659acdda91..59a9b7ae01 100644 --- a/modules/juce_gui_basics/mouse/juce_MouseEvent.h +++ b/modules/juce_gui_basics/mouse/juce_MouseEvent.h @@ -33,6 +33,8 @@ namespace juce @see MouseListener, Component::mouseMove, Component::mouseEnter, Component::mouseExit, Component::mouseDown, Component::mouseUp, Component::mouseDrag + + @tags{GUI} */ class JUCE_API MouseEvent final { @@ -377,6 +379,8 @@ private: Contains status information about a mouse wheel event. @see MouseListener, MouseEvent + + @tags{GUI} */ struct MouseWheelDetails final { @@ -417,6 +421,8 @@ struct MouseWheelDetails final Contains status information about a pen event. @see MouseListener, MouseEvent + + @tags{GUI} */ struct PenDetails final { diff --git a/modules/juce_gui_basics/mouse/juce_MouseInactivityDetector.h b/modules/juce_gui_basics/mouse/juce_MouseInactivityDetector.h index a965743573..8dffcd8e65 100644 --- a/modules/juce_gui_basics/mouse/juce_MouseInactivityDetector.h +++ b/modules/juce_gui_basics/mouse/juce_MouseInactivityDetector.h @@ -38,6 +38,8 @@ namespace juce After creating an instance of this, use addListener to get callbacks when the activity status changes. + + @tags{GUI} */ class JUCE_API MouseInactivityDetector : private Timer, private MouseListener diff --git a/modules/juce_gui_basics/mouse/juce_MouseInputSource.h b/modules/juce_gui_basics/mouse/juce_MouseInputSource.h index ad081d8b1d..523b8fd2f6 100644 --- a/modules/juce_gui_basics/mouse/juce_MouseInputSource.h +++ b/modules/juce_gui_basics/mouse/juce_MouseInputSource.h @@ -46,6 +46,8 @@ namespace juce method to find out which finger each event came from. @see MouseEvent + + @tags{GUI} */ class JUCE_API MouseInputSource final { diff --git a/modules/juce_gui_basics/mouse/juce_MouseListener.h b/modules/juce_gui_basics/mouse/juce_MouseListener.h index 859b91dec2..76160f4c6e 100644 --- a/modules/juce_gui_basics/mouse/juce_MouseListener.h +++ b/modules/juce_gui_basics/mouse/juce_MouseListener.h @@ -33,6 +33,8 @@ namespace juce about mouse events that happen to that component. @see Component::addMouseListener, Component::removeMouseListener + + @tags{GUI} */ class JUCE_API MouseListener { diff --git a/modules/juce_gui_basics/mouse/juce_SelectedItemSet.h b/modules/juce_gui_basics/mouse/juce_SelectedItemSet.h index dfd8888966..346fefe438 100644 --- a/modules/juce_gui_basics/mouse/juce_SelectedItemSet.h +++ b/modules/juce_gui_basics/mouse/juce_SelectedItemSet.h @@ -39,6 +39,8 @@ namespace juce To be informed when items are selected/deselected, register a ChangeListener with this object. + + @tags{GUI} */ template class SelectedItemSet : public ChangeBroadcaster diff --git a/modules/juce_gui_basics/mouse/juce_TextDragAndDropTarget.h b/modules/juce_gui_basics/mouse/juce_TextDragAndDropTarget.h index 088065c249..d84978264e 100644 --- a/modules/juce_gui_basics/mouse/juce_TextDragAndDropTarget.h +++ b/modules/juce_gui_basics/mouse/juce_TextDragAndDropTarget.h @@ -32,6 +32,8 @@ namespace juce Components derived from this class can have text dropped onto them by an external application. @see DragAndDropContainer + + @tags{GUI} */ class JUCE_API TextDragAndDropTarget { diff --git a/modules/juce_gui_basics/mouse/juce_TooltipClient.h b/modules/juce_gui_basics/mouse/juce_TooltipClient.h index 76407635bc..8519fe7743 100644 --- a/modules/juce_gui_basics/mouse/juce_TooltipClient.h +++ b/modules/juce_gui_basics/mouse/juce_TooltipClient.h @@ -36,6 +36,8 @@ namespace juce the tooltip returned by its getTooltip() method. @see TooltipWindow, SettableTooltipClient + + @tags{GUI} */ class JUCE_API TooltipClient { @@ -60,6 +62,8 @@ public: tooltips. @see TooltipClient, TooltipWindow + + @tags{GUI} */ class JUCE_API SettableTooltipClient : public TooltipClient { diff --git a/modules/juce_gui_basics/native/juce_linux_X11.h b/modules/juce_gui_basics/native/juce_linux_X11.h index 467c7c2b89..f5c5cdd98e 100644 --- a/modules/juce_gui_basics/native/juce_linux_X11.h +++ b/modules/juce_gui_basics/native/juce_linux_X11.h @@ -56,7 +56,10 @@ private: }; //============================================================================== -/** Creates and holds a reference to the X display. */ +/** Creates and holds a reference to the X display. + + @tags{GUI} +*/ struct ScopedXDisplay { ScopedXDisplay(); @@ -68,6 +71,8 @@ struct ScopedXDisplay //============================================================================== /** A handy class that uses XLockDisplay and XUnlockDisplay to lock the X server using RAII (Only available in Linux!). + + @tags{GUI} */ class ScopedXLock { diff --git a/modules/juce_gui_basics/positioning/juce_MarkerList.h b/modules/juce_gui_basics/positioning/juce_MarkerList.h index 0fde315bc1..d2c69b7788 100644 --- a/modules/juce_gui_basics/positioning/juce_MarkerList.h +++ b/modules/juce_gui_basics/positioning/juce_MarkerList.h @@ -33,6 +33,8 @@ namespace juce This class is used to store sets of X and Y marker points in components. @see Component::getMarkers(). + + @tags{GUI} */ class JUCE_API MarkerList { diff --git a/modules/juce_gui_basics/positioning/juce_RelativeCoordinate.h b/modules/juce_gui_basics/positioning/juce_RelativeCoordinate.h index 55d3edfded..176f6eba38 100644 --- a/modules/juce_gui_basics/positioning/juce_RelativeCoordinate.h +++ b/modules/juce_gui_basics/positioning/juce_RelativeCoordinate.h @@ -67,6 +67,8 @@ namespace juce be thrown! @see RelativePoint, RelativeRectangle + + @tags{GUI} */ class JUCE_API RelativeCoordinate { @@ -158,6 +160,7 @@ public: static const String height; /**< "height" */ }; + /** @internal */ struct StandardStrings { enum Type diff --git a/modules/juce_gui_basics/positioning/juce_RelativeCoordinatePositioner.h b/modules/juce_gui_basics/positioning/juce_RelativeCoordinatePositioner.h index 038f9dec65..b1ab4849ab 100644 --- a/modules/juce_gui_basics/positioning/juce_RelativeCoordinatePositioner.h +++ b/modules/juce_gui_basics/positioning/juce_RelativeCoordinatePositioner.h @@ -30,6 +30,8 @@ namespace juce //============================================================================== /** Base class for Component::Positioners that are based upon relative coordinates. + + @tags{GUI} */ class JUCE_API RelativeCoordinatePositionerBase : public Component::Positioner, public ComponentListener, diff --git a/modules/juce_gui_basics/positioning/juce_RelativeParallelogram.h b/modules/juce_gui_basics/positioning/juce_RelativeParallelogram.h index afd88c9f0c..7ba3b3835e 100644 --- a/modules/juce_gui_basics/positioning/juce_RelativeParallelogram.h +++ b/modules/juce_gui_basics/positioning/juce_RelativeParallelogram.h @@ -32,6 +32,8 @@ namespace juce A parallelogram defined by three RelativePoint positions. @see RelativePoint, RelativeCoordinate + + @tags{GUI} */ class JUCE_API RelativeParallelogram { diff --git a/modules/juce_gui_basics/positioning/juce_RelativePoint.h b/modules/juce_gui_basics/positioning/juce_RelativePoint.h index 7bf446690b..b6da5b2d1a 100644 --- a/modules/juce_gui_basics/positioning/juce_RelativePoint.h +++ b/modules/juce_gui_basics/positioning/juce_RelativePoint.h @@ -32,6 +32,8 @@ namespace juce An X-Y position stored as a pair of RelativeCoordinate values. @see RelativeCoordinate, RelativeRectangle + + @tags{GUI} */ class JUCE_API RelativePoint { diff --git a/modules/juce_gui_basics/positioning/juce_RelativePointPath.h b/modules/juce_gui_basics/positioning/juce_RelativePointPath.h index 95e605879d..ddcda84708 100644 --- a/modules/juce_gui_basics/positioning/juce_RelativePointPath.h +++ b/modules/juce_gui_basics/positioning/juce_RelativePointPath.h @@ -35,6 +35,8 @@ namespace juce unlike a Path, its points can be dynamic instead of just fixed. @see RelativePoint, RelativeCoordinate + + @tags{GUI} */ class JUCE_API RelativePointPath { @@ -92,6 +94,7 @@ public: }; //============================================================================== + /** Class for the start sub path element */ class JUCE_API StartSubPath : public ElementBase { public: @@ -107,6 +110,7 @@ public: }; //============================================================================== + /** Class for the close sub path element */ class JUCE_API CloseSubPath : public ElementBase { public: @@ -120,6 +124,7 @@ public: }; //============================================================================== + /** Class for the line to element */ class JUCE_API LineTo : public ElementBase { public: @@ -135,6 +140,7 @@ public: }; //============================================================================== + /** Class for the quadratic to element */ class JUCE_API QuadraticTo : public ElementBase { public: @@ -151,6 +157,7 @@ public: }; //============================================================================== + /** Class for the cubic to element */ class JUCE_API CubicTo : public ElementBase { public: diff --git a/modules/juce_gui_basics/positioning/juce_RelativeRectangle.h b/modules/juce_gui_basics/positioning/juce_RelativeRectangle.h index 4113769de7..08db47fc38 100644 --- a/modules/juce_gui_basics/positioning/juce_RelativeRectangle.h +++ b/modules/juce_gui_basics/positioning/juce_RelativeRectangle.h @@ -34,6 +34,8 @@ namespace juce The rectangle's top, left, bottom and right edge positions are each stored as a RelativeCoordinate. @see RelativeCoordinate, RelativePoint + + @tags{GUI} */ class JUCE_API RelativeRectangle { diff --git a/modules/juce_gui_basics/properties/juce_BooleanPropertyComponent.h b/modules/juce_gui_basics/properties/juce_BooleanPropertyComponent.h index c373ac5473..5f92d73b6c 100644 --- a/modules/juce_gui_basics/properties/juce_BooleanPropertyComponent.h +++ b/modules/juce_gui_basics/properties/juce_BooleanPropertyComponent.h @@ -35,6 +35,8 @@ namespace juce toggle on/off. @see PropertyComponent + + @tags{GUI} */ class JUCE_API BooleanPropertyComponent : public PropertyComponent { diff --git a/modules/juce_gui_basics/properties/juce_ButtonPropertyComponent.h b/modules/juce_gui_basics/properties/juce_ButtonPropertyComponent.h index 0689f8ccd9..66885f239a 100644 --- a/modules/juce_gui_basics/properties/juce_ButtonPropertyComponent.h +++ b/modules/juce_gui_basics/properties/juce_ButtonPropertyComponent.h @@ -35,6 +35,8 @@ namespace juce kind of action. @see PropertyComponent + + @tags{GUI} */ class JUCE_API ButtonPropertyComponent : public PropertyComponent { diff --git a/modules/juce_gui_basics/properties/juce_ChoicePropertyComponent.h b/modules/juce_gui_basics/properties/juce_ChoicePropertyComponent.h index 40379aafe8..6cc0c7706c 100644 --- a/modules/juce_gui_basics/properties/juce_ChoicePropertyComponent.h +++ b/modules/juce_gui_basics/properties/juce_ChoicePropertyComponent.h @@ -45,6 +45,8 @@ namespace juce called to let your class process this. @see PropertyComponent, PropertyPanel + + @tags{GUI} */ class JUCE_API ChoicePropertyComponent : public PropertyComponent { diff --git a/modules/juce_gui_basics/properties/juce_PropertyComponent.h b/modules/juce_gui_basics/properties/juce_PropertyComponent.h index 745a3b1b93..d29c7b36f8 100644 --- a/modules/juce_gui_basics/properties/juce_PropertyComponent.h +++ b/modules/juce_gui_basics/properties/juce_PropertyComponent.h @@ -42,6 +42,8 @@ namespace juce @see PropertyPanel, TextPropertyComponent, SliderPropertyComponent, ChoicePropertyComponent, ButtonPropertyComponent, BooleanPropertyComponent + + @tags{GUI} */ class JUCE_API PropertyComponent : public Component, public SettableTooltipClient diff --git a/modules/juce_gui_basics/properties/juce_PropertyPanel.h b/modules/juce_gui_basics/properties/juce_PropertyPanel.h index 49ab8fde4e..8aedf8a0f8 100644 --- a/modules/juce_gui_basics/properties/juce_PropertyPanel.h +++ b/modules/juce_gui_basics/properties/juce_PropertyPanel.h @@ -38,6 +38,8 @@ namespace juce or addSection(). @see PropertyComponent + + @tags{GUI} */ class JUCE_API PropertyPanel : public Component { diff --git a/modules/juce_gui_basics/properties/juce_SliderPropertyComponent.h b/modules/juce_gui_basics/properties/juce_SliderPropertyComponent.h index 408c8c43e6..e814fc80c6 100644 --- a/modules/juce_gui_basics/properties/juce_SliderPropertyComponent.h +++ b/modules/juce_gui_basics/properties/juce_SliderPropertyComponent.h @@ -32,6 +32,8 @@ namespace juce A PropertyComponent that shows its value as a slider. @see PropertyComponent, Slider + + @tags{GUI} */ class JUCE_API SliderPropertyComponent : public PropertyComponent { diff --git a/modules/juce_gui_basics/properties/juce_TextPropertyComponent.h b/modules/juce_gui_basics/properties/juce_TextPropertyComponent.h index 2b2e62e699..8d42d34578 100644 --- a/modules/juce_gui_basics/properties/juce_TextPropertyComponent.h +++ b/modules/juce_gui_basics/properties/juce_TextPropertyComponent.h @@ -32,6 +32,8 @@ namespace juce A PropertyComponent that shows its value as editable text. @see PropertyComponent + + @tags{GUI} */ class JUCE_API TextPropertyComponent : public PropertyComponent { @@ -122,6 +124,7 @@ public: void colourChanged() override; //============================================================================== + /** Used to receive callbacks for text changes */ class JUCE_API Listener { public: diff --git a/modules/juce_gui_basics/widgets/juce_ComboBox.h b/modules/juce_gui_basics/widgets/juce_ComboBox.h index a3d35735b8..016ac03a4b 100644 --- a/modules/juce_gui_basics/widgets/juce_ComboBox.h +++ b/modules/juce_gui_basics/widgets/juce_ComboBox.h @@ -40,6 +40,8 @@ namespace juce To find out when the user selects a different item or edits the text, you can assign a lambda to the onChange member, or register a ComboBox::Listener to receive callbacks. + + @tags{GUI} */ class JUCE_API ComboBox : public Component, public SettableTooltipClient, diff --git a/modules/juce_gui_basics/widgets/juce_ImageComponent.h b/modules/juce_gui_basics/widgets/juce_ImageComponent.h index 3872634729..80bdda510b 100644 --- a/modules/juce_gui_basics/widgets/juce_ImageComponent.h +++ b/modules/juce_gui_basics/widgets/juce_ImageComponent.h @@ -32,6 +32,8 @@ namespace juce A component that simply displays an image. Use setImage to give it an image, and it'll display it - simple as that! + + @tags{GUI} */ class JUCE_API ImageComponent : public Component, public SettableTooltipClient diff --git a/modules/juce_gui_basics/widgets/juce_Label.h b/modules/juce_gui_basics/widgets/juce_Label.h index ac86644fc9..6bcfad8554 100644 --- a/modules/juce_gui_basics/widgets/juce_Label.h +++ b/modules/juce_gui_basics/widgets/juce_Label.h @@ -31,6 +31,8 @@ namespace juce /** A component that displays a text string, and can optionally become a text editor when clicked. + + @tags{GUI} */ class JUCE_API Label : public Component, public SettableTooltipClient, diff --git a/modules/juce_gui_basics/widgets/juce_ListBox.h b/modules/juce_gui_basics/widgets/juce_ListBox.h index 27f8fe5484..45804b3936 100644 --- a/modules/juce_gui_basics/widgets/juce_ListBox.h +++ b/modules/juce_gui_basics/widgets/juce_ListBox.h @@ -32,6 +32,8 @@ namespace juce A subclass of this is used to drive a ListBox. @see ListBox + + @tags{GUI} */ class JUCE_API ListBoxModel { @@ -174,6 +176,8 @@ private: more specialised tasks, it can supply a custom component to fill each row. @see ComboBox, TableListBox + + @tags{GUI} */ class JUCE_API ListBox : public Component, public SettableTooltipClient diff --git a/modules/juce_gui_basics/widgets/juce_ProgressBar.h b/modules/juce_gui_basics/widgets/juce_ProgressBar.h index d462be1d52..cc5dd8d6b4 100644 --- a/modules/juce_gui_basics/widgets/juce_ProgressBar.h +++ b/modules/juce_gui_basics/widgets/juce_ProgressBar.h @@ -43,6 +43,8 @@ namespace juce progress, see the ThreadWithProgressWindow class. @see ThreadWithProgressWindow + + @tags{GUI} */ class JUCE_API ProgressBar : public Component, public SettableTooltipClient, diff --git a/modules/juce_gui_basics/widgets/juce_Slider.h b/modules/juce_gui_basics/widgets/juce_Slider.h index 90c268ffb0..bae589fc2a 100644 --- a/modules/juce_gui_basics/widgets/juce_Slider.h +++ b/modules/juce_gui_basics/widgets/juce_Slider.h @@ -47,6 +47,8 @@ namespace juce the value changes. @see Slider::Listener + + @tags{GUI} */ class JUCE_API Slider : public Component, public SettableTooltipClient @@ -139,6 +141,7 @@ public: SliderStyle getSliderStyle() const noexcept; //============================================================================== + /** Structure defining rotary parameters for a slider */ struct RotaryParameters { /** The angle (in radians, clockwise from the top) at which diff --git a/modules/juce_gui_basics/widgets/juce_TableHeaderComponent.h b/modules/juce_gui_basics/widgets/juce_TableHeaderComponent.h index f41962dec6..18185561fd 100644 --- a/modules/juce_gui_basics/widgets/juce_TableHeaderComponent.h +++ b/modules/juce_gui_basics/widgets/juce_TableHeaderComponent.h @@ -40,6 +40,8 @@ namespace juce Each column must be given a unique ID number that's used to refer to it. @see TableListBox, TableHeaderComponent::Listener + + @tags{GUI} */ class JUCE_API TableHeaderComponent : public Component, private AsyncUpdater diff --git a/modules/juce_gui_basics/widgets/juce_TableListBox.h b/modules/juce_gui_basics/widgets/juce_TableListBox.h index 050d831012..4467a0f338 100644 --- a/modules/juce_gui_basics/widgets/juce_TableListBox.h +++ b/modules/juce_gui_basics/widgets/juce_TableListBox.h @@ -35,6 +35,8 @@ namespace juce table cells, and reacting to events. @see TableListBox + + @tags{GUI} */ class JUCE_API TableListBoxModel { @@ -203,6 +205,8 @@ private: @see TableListBoxModel, TableHeaderComponent + + @tags{GUI} */ class JUCE_API TableListBox : public ListBox, private ListBoxModel, diff --git a/modules/juce_gui_basics/widgets/juce_TextEditor.h b/modules/juce_gui_basics/widgets/juce_TextEditor.h index 7616d6a487..60f348fdcf 100644 --- a/modules/juce_gui_basics/widgets/juce_TextEditor.h +++ b/modules/juce_gui_basics/widgets/juce_TextEditor.h @@ -35,6 +35,8 @@ namespace juce fonts and colours. @see TextEditor::Listener, Label + + @tags{GUI} */ class JUCE_API TextEditor : public Component, public TextInputTarget, diff --git a/modules/juce_gui_basics/widgets/juce_Toolbar.h b/modules/juce_gui_basics/widgets/juce_Toolbar.h index 70a9addb3f..b6a1544289 100644 --- a/modules/juce_gui_basics/widgets/juce_Toolbar.h +++ b/modules/juce_gui_basics/widgets/juce_Toolbar.h @@ -47,6 +47,8 @@ class ToolbarItemFactory; component as a source of new items. @see ToolbarItemFactory, ToolbarItemComponent, ToolbarItemPalette + + @tags{GUI} */ class JUCE_API Toolbar : public Component, public DragAndDropContainer, diff --git a/modules/juce_gui_basics/widgets/juce_ToolbarItemComponent.h b/modules/juce_gui_basics/widgets/juce_ToolbarItemComponent.h index 662ca6bc2c..4fe8d4a256 100644 --- a/modules/juce_gui_basics/widgets/juce_ToolbarItemComponent.h +++ b/modules/juce_gui_basics/widgets/juce_ToolbarItemComponent.h @@ -44,6 +44,8 @@ namespace juce ToolbarButton class. @see ToolbarButton, Toolbar, ToolbarItemFactory + + @tags{GUI} */ class JUCE_API ToolbarItemComponent : public Button { diff --git a/modules/juce_gui_basics/widgets/juce_ToolbarItemFactory.h b/modules/juce_gui_basics/widgets/juce_ToolbarItemFactory.h index d6c4fdde8d..887ae0804d 100644 --- a/modules/juce_gui_basics/widgets/juce_ToolbarItemFactory.h +++ b/modules/juce_gui_basics/widgets/juce_ToolbarItemFactory.h @@ -39,6 +39,8 @@ namespace juce bars). @see Toolbar, ToolbarItemComponent, ToolbarButton + + @tags{GUI} */ class JUCE_API ToolbarItemFactory { diff --git a/modules/juce_gui_basics/widgets/juce_ToolbarItemPalette.h b/modules/juce_gui_basics/widgets/juce_ToolbarItemPalette.h index bbfccf1fbe..a5765b0aea 100644 --- a/modules/juce_gui_basics/widgets/juce_ToolbarItemPalette.h +++ b/modules/juce_gui_basics/widgets/juce_ToolbarItemPalette.h @@ -36,6 +36,8 @@ namespace juce which automatically shows one of these in a dialog box with lots of extra controls. @see Toolbar + + @tags{GUI} */ class JUCE_API ToolbarItemPalette : public Component, public DragAndDropContainer diff --git a/modules/juce_gui_basics/widgets/juce_TreeView.h b/modules/juce_gui_basics/widgets/juce_TreeView.h index 8cd0a20f48..8ff8f85a3d 100644 --- a/modules/juce_gui_basics/widgets/juce_TreeView.h +++ b/modules/juce_gui_basics/widgets/juce_TreeView.h @@ -43,6 +43,8 @@ class TreeView; do this the first time it's opened, or it might want to refresh itself each time. It also has the option of deleting its sub-items when it is closed, or leaving them in place. + + @tags{GUI} */ class JUCE_API TreeViewItem { @@ -631,6 +633,8 @@ private: Use one of these to hold and display a structure of TreeViewItem objects. + + @tags{GUI} */ class JUCE_API TreeView : public Component, public SettableTooltipClient, diff --git a/modules/juce_gui_basics/windows/juce_AlertWindow.h b/modules/juce_gui_basics/windows/juce_AlertWindow.h index c28ee6bd0e..c6edf07e62 100644 --- a/modules/juce_gui_basics/windows/juce_AlertWindow.h +++ b/modules/juce_gui_basics/windows/juce_AlertWindow.h @@ -39,6 +39,8 @@ namespace juce user pressed to dismiss the box. @see ThreadWithProgressWindow + + @tags{GUI} */ class JUCE_API AlertWindow : public TopLevelWindow { diff --git a/modules/juce_gui_basics/windows/juce_CallOutBox.h b/modules/juce_gui_basics/windows/juce_CallOutBox.h index fbfecb82c3..79293921f6 100644 --- a/modules/juce_gui_basics/windows/juce_CallOutBox.h +++ b/modules/juce_gui_basics/windows/juce_CallOutBox.h @@ -53,6 +53,8 @@ namespace juce @endcode The call-out will resize and position itself when the content changes size. + + @tags{GUI} */ class JUCE_API CallOutBox : public Component, private Timer diff --git a/modules/juce_gui_basics/windows/juce_ComponentPeer.h b/modules/juce_gui_basics/windows/juce_ComponentPeer.h index 819cc8d93f..49384e5070 100644 --- a/modules/juce_gui_basics/windows/juce_ComponentPeer.h +++ b/modules/juce_gui_basics/windows/juce_ComponentPeer.h @@ -38,6 +38,8 @@ namespace juce User-code should very rarely need to have any involvement with this class. @see Component::createNewPeer + + @tags{GUI} */ class JUCE_API ComponentPeer { @@ -323,6 +325,7 @@ public: void handleUserClosingWindow(); + /** Structure to describe drag and drop information */ struct DragInfo { StringArray files; diff --git a/modules/juce_gui_basics/windows/juce_DialogWindow.h b/modules/juce_gui_basics/windows/juce_DialogWindow.h index db5516b072..e5ef3a4b95 100644 --- a/modules/juce_gui_basics/windows/juce_DialogWindow.h +++ b/modules/juce_gui_basics/windows/juce_DialogWindow.h @@ -46,6 +46,8 @@ namespace juce button - for more info, see the DocumentWindow help. @see DocumentWindow, ResizableWindow + + @tags{GUI} */ class JUCE_API DialogWindow : public DocumentWindow { diff --git a/modules/juce_gui_basics/windows/juce_DocumentWindow.h b/modules/juce_gui_basics/windows/juce_DocumentWindow.h index ca75123e71..75be25ae98 100644 --- a/modules/juce_gui_basics/windows/juce_DocumentWindow.h +++ b/modules/juce_gui_basics/windows/juce_DocumentWindow.h @@ -49,6 +49,8 @@ namespace juce method. @see ResizableWindow, DialogWindow + + @tags{GUI} */ class JUCE_API DocumentWindow : public ResizableWindow { diff --git a/modules/juce_gui_basics/windows/juce_NativeMessageBox.h b/modules/juce_gui_basics/windows/juce_NativeMessageBox.h index dffc70d9f8..217762556f 100644 --- a/modules/juce_gui_basics/windows/juce_NativeMessageBox.h +++ b/modules/juce_gui_basics/windows/juce_NativeMessageBox.h @@ -30,6 +30,8 @@ namespace juce //============================================================================== /** This class contains some static methods for showing native alert windows. + + @tags{GUI} */ class NativeMessageBox { diff --git a/modules/juce_gui_basics/windows/juce_ResizableWindow.h b/modules/juce_gui_basics/windows/juce_ResizableWindow.h index fd81cc933e..e3f5521705 100644 --- a/modules/juce_gui_basics/windows/juce_ResizableWindow.h +++ b/modules/juce_gui_basics/windows/juce_ResizableWindow.h @@ -46,6 +46,8 @@ namespace juce to choose the style of resizing to use. @see TopLevelWindow + + @tags{GUI} */ class JUCE_API ResizableWindow : public TopLevelWindow { diff --git a/modules/juce_gui_basics/windows/juce_ThreadWithProgressWindow.h b/modules/juce_gui_basics/windows/juce_ThreadWithProgressWindow.h index 06e408fd47..6133fd4698 100644 --- a/modules/juce_gui_basics/windows/juce_ThreadWithProgressWindow.h +++ b/modules/juce_gui_basics/windows/juce_ThreadWithProgressWindow.h @@ -78,6 +78,8 @@ namespace juce @endcode @see Thread, AlertWindow + + @tags{GUI} */ class JUCE_API ThreadWithProgressWindow : public Thread, private Timer diff --git a/modules/juce_gui_basics/windows/juce_TooltipWindow.h b/modules/juce_gui_basics/windows/juce_TooltipWindow.h index 7ef54a5a31..a73f0f750c 100644 --- a/modules/juce_gui_basics/windows/juce_TooltipWindow.h +++ b/modules/juce_gui_basics/windows/juce_TooltipWindow.h @@ -44,6 +44,8 @@ namespace juce it will make itself visible to show the tooltip in the appropriate place. @see TooltipClient, SettableTooltipClient, SharedResourcePointer + + @tags{GUI} */ class JUCE_API TooltipWindow : public Component, private Timer diff --git a/modules/juce_gui_basics/windows/juce_TopLevelWindow.h b/modules/juce_gui_basics/windows/juce_TopLevelWindow.h index 6b60851bae..22ec8a0e32 100644 --- a/modules/juce_gui_basics/windows/juce_TopLevelWindow.h +++ b/modules/juce_gui_basics/windows/juce_TopLevelWindow.h @@ -48,6 +48,8 @@ namespace juce A top-level window also has an optional drop-shadow. @see ResizableWindow, DocumentWindow, DialogWindow + + @tags{GUI} */ class JUCE_API TopLevelWindow : public Component { diff --git a/modules/juce_gui_extra/code_editor/juce_CPlusPlusCodeTokeniser.h b/modules/juce_gui_extra/code_editor/juce_CPlusPlusCodeTokeniser.h index 0eaa420460..1c0cdc9009 100644 --- a/modules/juce_gui_extra/code_editor/juce_CPlusPlusCodeTokeniser.h +++ b/modules/juce_gui_extra/code_editor/juce_CPlusPlusCodeTokeniser.h @@ -32,6 +32,8 @@ namespace juce A simple lexical analyser for syntax colouring of C++ code. @see CodeEditorComponent, CodeDocument + + @tags{GUI} */ class JUCE_API CPlusPlusCodeTokeniser : public CodeTokeniser { diff --git a/modules/juce_gui_extra/code_editor/juce_CPlusPlusCodeTokeniserFunctions.h b/modules/juce_gui_extra/code_editor/juce_CPlusPlusCodeTokeniserFunctions.h index dc389b8087..706024efc5 100644 --- a/modules/juce_gui_extra/code_editor/juce_CPlusPlusCodeTokeniserFunctions.h +++ b/modules/juce_gui_extra/code_editor/juce_CPlusPlusCodeTokeniserFunctions.h @@ -29,6 +29,8 @@ namespace juce //============================================================================== /** Class containing some basic functions for simple tokenising of C++ code. + + @tags{GUI} */ struct CppTokeniserFunctions { diff --git a/modules/juce_gui_extra/code_editor/juce_CodeDocument.h b/modules/juce_gui_extra/code_editor/juce_CodeDocument.h index d03f098c15..99ad87a770 100644 --- a/modules/juce_gui_extra/code_editor/juce_CodeDocument.h +++ b/modules/juce_gui_extra/code_editor/juce_CodeDocument.h @@ -40,6 +40,8 @@ class CodeDocumentLine; quick to insert and delete. @see CodeEditorComponent + + @tags{GUI} */ class JUCE_API CodeDocument { diff --git a/modules/juce_gui_extra/code_editor/juce_CodeEditorComponent.h b/modules/juce_gui_extra/code_editor/juce_CodeEditorComponent.h index 59e81d71c4..03781883ca 100644 --- a/modules/juce_gui_extra/code_editor/juce_CodeEditorComponent.h +++ b/modules/juce_gui_extra/code_editor/juce_CodeEditorComponent.h @@ -36,6 +36,8 @@ class CodeTokeniser; This is designed to handle syntax highlighting and fast editing of very large files. + + @tags{GUI} */ class JUCE_API CodeEditorComponent : public Component, public ApplicationCommandTarget, @@ -219,8 +221,10 @@ public: bool isReadOnly() const noexcept { return readOnly; } //============================================================================== + /** Defines a syntax highlighting colour scheme */ struct JUCE_API ColourScheme { + /** Defines a colour for a token type */ struct TokenType { String name; diff --git a/modules/juce_gui_extra/code_editor/juce_CodeTokeniser.h b/modules/juce_gui_extra/code_editor/juce_CodeTokeniser.h index 5e5e1ab3e0..e011352327 100644 --- a/modules/juce_gui_extra/code_editor/juce_CodeTokeniser.h +++ b/modules/juce_gui_extra/code_editor/juce_CodeTokeniser.h @@ -33,6 +33,8 @@ namespace juce code editor. @see CodeDocument, CodeEditorComponent + + @tags{GUI} */ class JUCE_API CodeTokeniser { diff --git a/modules/juce_gui_extra/code_editor/juce_LuaCodeTokeniser.h b/modules/juce_gui_extra/code_editor/juce_LuaCodeTokeniser.h index 5628cfa59f..ef223626ab 100644 --- a/modules/juce_gui_extra/code_editor/juce_LuaCodeTokeniser.h +++ b/modules/juce_gui_extra/code_editor/juce_LuaCodeTokeniser.h @@ -29,6 +29,8 @@ namespace juce //============================================================================== /** + + @tags{GUI} */ class JUCE_API LuaTokeniser : public CodeTokeniser { diff --git a/modules/juce_gui_extra/code_editor/juce_XMLCodeTokeniser.h b/modules/juce_gui_extra/code_editor/juce_XMLCodeTokeniser.h index 9fb3f87918..3a429d8779 100644 --- a/modules/juce_gui_extra/code_editor/juce_XMLCodeTokeniser.h +++ b/modules/juce_gui_extra/code_editor/juce_XMLCodeTokeniser.h @@ -29,6 +29,8 @@ namespace juce //============================================================================== /** + + @tags{GUI} */ class JUCE_API XmlTokeniser : public CodeTokeniser { diff --git a/modules/juce_gui_extra/documents/juce_FileBasedDocument.h b/modules/juce_gui_extra/documents/juce_FileBasedDocument.h index 42e39270d5..3033b4cb21 100644 --- a/modules/juce_gui_extra/documents/juce_FileBasedDocument.h +++ b/modules/juce_gui_extra/documents/juce_FileBasedDocument.h @@ -46,6 +46,8 @@ namespace juce ChangeBroadcaster base class. @see ChangeBroadcaster + + @tags{GUI} */ class JUCE_API FileBasedDocument : public ChangeBroadcaster { diff --git a/modules/juce_gui_extra/embedding/juce_ActiveXControlComponent.h b/modules/juce_gui_extra/embedding/juce_ActiveXControlComponent.h index 716b29b456..c3c81fc882 100644 --- a/modules/juce_gui_extra/embedding/juce_ActiveXControlComponent.h +++ b/modules/juce_gui_extra/embedding/juce_ActiveXControlComponent.h @@ -40,6 +40,8 @@ namespace juce Of course, since the control is a heavyweight window, it'll obliterate any JUCE components that may overlap this component, but that's life. + + @tags{GUI} */ class JUCE_API ActiveXControlComponent : public Component { diff --git a/modules/juce_gui_extra/embedding/juce_AndroidViewComponent.h b/modules/juce_gui_extra/embedding/juce_AndroidViewComponent.h index 49bc6b4a12..bc3ba52c45 100644 --- a/modules/juce_gui_extra/embedding/juce_AndroidViewComponent.h +++ b/modules/juce_gui_extra/embedding/juce_AndroidViewComponent.h @@ -39,6 +39,8 @@ namespace juce Of course, since the view is a native object, it'll obliterate any juce components that may overlap this component, but that's life. + + @tags{GUI} */ class JUCE_API AndroidViewComponent : public Component { diff --git a/modules/juce_gui_extra/embedding/juce_NSViewComponent.h b/modules/juce_gui_extra/embedding/juce_NSViewComponent.h index 2db7fe5c93..ec70611c57 100644 --- a/modules/juce_gui_extra/embedding/juce_NSViewComponent.h +++ b/modules/juce_gui_extra/embedding/juce_NSViewComponent.h @@ -39,6 +39,8 @@ namespace juce Of course, since the view is a native object, it'll obliterate any juce components that may overlap this component, but that's life. + + @tags{GUI} */ class JUCE_API NSViewComponent : public Component { diff --git a/modules/juce_gui_extra/embedding/juce_UIViewComponent.h b/modules/juce_gui_extra/embedding/juce_UIViewComponent.h index d478aef286..7a98d62776 100644 --- a/modules/juce_gui_extra/embedding/juce_UIViewComponent.h +++ b/modules/juce_gui_extra/embedding/juce_UIViewComponent.h @@ -39,6 +39,8 @@ namespace juce Of course, since the view is a native object, it'll obliterate any juce components that may overlap this component, but that's life. + + @tags{GUI} */ class JUCE_API UIViewComponent : public Component { diff --git a/modules/juce_gui_extra/embedding/juce_XEmbedComponent.h b/modules/juce_gui_extra/embedding/juce_XEmbedComponent.h index e3935e451c..98c21c63e9 100644 --- a/modules/juce_gui_extra/embedding/juce_XEmbedComponent.h +++ b/modules/juce_gui_extra/embedding/juce_XEmbedComponent.h @@ -60,6 +60,8 @@ unsigned long juce_getCurrentFocusWindow (ComponentPeer*); Other toolkits or raw X11 widgets should follow the X11 embed protocol: https://specifications.freedesktop.org/xembed-spec/xembed-spec-latest.html + + @tags{GUI} */ class XEmbedComponent : public Component { diff --git a/modules/juce_gui_extra/misc/juce_AnimatedAppComponent.h b/modules/juce_gui_extra/misc/juce_AnimatedAppComponent.h index 9d84552772..0872e7cac5 100644 --- a/modules/juce_gui_extra/misc/juce_AnimatedAppComponent.h +++ b/modules/juce_gui_extra/misc/juce_AnimatedAppComponent.h @@ -34,6 +34,8 @@ namespace juce A subclass can inherit from this and implement just a few methods such as paint() and mouse-handling. The base class provides some simple abstractions to take care of continuously repainting itself. + + @tags{GUI} */ class AnimatedAppComponent : public Component, private Timer diff --git a/modules/juce_gui_extra/misc/juce_AppleRemote.h b/modules/juce_gui_extra/misc/juce_AppleRemote.h index 1f27dc9d15..08be5dd80e 100644 --- a/modules/juce_gui_extra/misc/juce_AppleRemote.h +++ b/modules/juce_gui_extra/misc/juce_AppleRemote.h @@ -34,6 +34,8 @@ namespace juce To use it, just create a subclass of this class, implementing the buttonPressed() callback, then call start() and stop() to start or stop receiving events. + + @tags{GUI} */ class JUCE_API AppleRemoteDevice { diff --git a/modules/juce_gui_extra/misc/juce_BubbleMessageComponent.h b/modules/juce_gui_extra/misc/juce_BubbleMessageComponent.h index 785d542a96..084d2cdb6f 100644 --- a/modules/juce_gui_extra/misc/juce_BubbleMessageComponent.h +++ b/modules/juce_gui_extra/misc/juce_BubbleMessageComponent.h @@ -35,6 +35,8 @@ namespace juce pointing to a particular component or location on the screen. @see BubbleComponent + + @tags{GUI} */ class JUCE_API BubbleMessageComponent : public BubbleComponent, private Timer diff --git a/modules/juce_gui_extra/misc/juce_ColourSelector.h b/modules/juce_gui_extra/misc/juce_ColourSelector.h index a3cd3faaee..39b153115a 100644 --- a/modules/juce_gui_extra/misc/juce_ColourSelector.h +++ b/modules/juce_gui_extra/misc/juce_ColourSelector.h @@ -35,6 +35,8 @@ namespace juce This class is also a ChangeBroadcaster, so listeners can register to be told when the colour changes. + + @tags{GUI} */ class JUCE_API ColourSelector : public Component, public ChangeBroadcaster diff --git a/modules/juce_gui_extra/misc/juce_KeyMappingEditorComponent.h b/modules/juce_gui_extra/misc/juce_KeyMappingEditorComponent.h index e206c1e68b..b9d5d1be05 100644 --- a/modules/juce_gui_extra/misc/juce_KeyMappingEditorComponent.h +++ b/modules/juce_gui_extra/misc/juce_KeyMappingEditorComponent.h @@ -33,6 +33,8 @@ namespace juce object. @see KeyPressMappingSet + + @tags{GUI} */ class JUCE_API KeyMappingEditorComponent : public Component { diff --git a/modules/juce_gui_extra/misc/juce_PreferencesPanel.h b/modules/juce_gui_extra/misc/juce_PreferencesPanel.h index 5c74d4a8c1..9ac4b39714 100644 --- a/modules/juce_gui_extra/misc/juce_PreferencesPanel.h +++ b/modules/juce_gui_extra/misc/juce_PreferencesPanel.h @@ -43,6 +43,8 @@ namespace juce To use it, just add a set of named pages with the addSettingsPage() method, and implement the createComponentForPage() method to create suitable components for each of these pages. + + @tags{GUI} */ class JUCE_API PreferencesPanel : public Component { diff --git a/modules/juce_gui_extra/misc/juce_PushNotifications.h b/modules/juce_gui_extra/misc/juce_PushNotifications.h index b3b194d2d7..5b004949f3 100644 --- a/modules/juce_gui_extra/misc/juce_PushNotifications.h +++ b/modules/juce_gui_extra/misc/juce_PushNotifications.h @@ -40,6 +40,8 @@ namespace juce remote notifications, inspect the Notification's fields for notification details. Bear in mind that some fields will not be available when receiving a remote notification. + + @tags{GUI} */ class JUCE_API PushNotifications : private DeletedAtShutdown { diff --git a/modules/juce_gui_extra/misc/juce_RecentlyOpenedFilesList.h b/modules/juce_gui_extra/misc/juce_RecentlyOpenedFilesList.h index 0408d203b2..a56949ddc3 100644 --- a/modules/juce_gui_extra/misc/juce_RecentlyOpenedFilesList.h +++ b/modules/juce_gui_extra/misc/juce_RecentlyOpenedFilesList.h @@ -36,6 +36,8 @@ namespace juce adding them to a menu, and making persistence easy. @see File, FileBasedDocument + + @tags{GUI} */ class JUCE_API RecentlyOpenedFilesList { diff --git a/modules/juce_gui_extra/misc/juce_SplashScreen.h b/modules/juce_gui_extra/misc/juce_SplashScreen.h index bf16e5d0aa..c011a3d2f0 100644 --- a/modules/juce_gui_extra/misc/juce_SplashScreen.h +++ b/modules/juce_gui_extra/misc/juce_SplashScreen.h @@ -67,6 +67,8 @@ namespace juce } @endcode + + @tags{GUI} */ class JUCE_API SplashScreen : public Component, private Timer, diff --git a/modules/juce_gui_extra/misc/juce_SystemTrayIconComponent.h b/modules/juce_gui_extra/misc/juce_SystemTrayIconComponent.h index 6dd877ddd2..eecd15bcbb 100644 --- a/modules/juce_gui_extra/misc/juce_SystemTrayIconComponent.h +++ b/modules/juce_gui_extra/misc/juce_SystemTrayIconComponent.h @@ -49,6 +49,8 @@ namespace juce position will not be valid, you can use this to respond to clicks. Traditionally you'd use a left-click to show your application's window, and a right-click to show a pop-up menu. + + @tags{GUI} */ class JUCE_API SystemTrayIconComponent : public Component { diff --git a/modules/juce_gui_extra/misc/juce_WebBrowserComponent.h b/modules/juce_gui_extra/misc/juce_WebBrowserComponent.h index cee0258240..36cf53954e 100644 --- a/modules/juce_gui_extra/misc/juce_WebBrowserComponent.h +++ b/modules/juce_gui_extra/misc/juce_WebBrowserComponent.h @@ -36,6 +36,8 @@ namespace juce The browser itself will be platform-dependent. On the Mac, probably Safari, on Windows, probably IE. + + @tags{GUI} */ class JUCE_API WebBrowserComponent : public Component { diff --git a/modules/juce_gui_extra/native/juce_mac_CarbonViewWrapperComponent.h b/modules/juce_gui_extra/native/juce_mac_CarbonViewWrapperComponent.h index c57277db6b..41ddde6008 100644 --- a/modules/juce_gui_extra/native/juce_mac_CarbonViewWrapperComponent.h +++ b/modules/juce_gui_extra/native/juce_mac_CarbonViewWrapperComponent.h @@ -33,6 +33,8 @@ namespace juce This is a handy class that's designed to be inlined where needed, e.g. in the audio plugin hosting code. + + @tags{GUI} */ class CarbonViewWrapperComponent : public Component, public ComponentMovementWatcher, diff --git a/modules/juce_opengl/geometry/juce_Draggable3DOrientation.h b/modules/juce_opengl/geometry/juce_Draggable3DOrientation.h index 8b11dff6f6..ccad03a897 100644 --- a/modules/juce_opengl/geometry/juce_Draggable3DOrientation.h +++ b/modules/juce_opengl/geometry/juce_Draggable3DOrientation.h @@ -30,6 +30,8 @@ namespace juce //============================================================================== /** Stores a 3D orientation, which can be rotated by dragging with the mouse. + + @tags{OpenGL} */ class Draggable3DOrientation { diff --git a/modules/juce_opengl/geometry/juce_Matrix3D.h b/modules/juce_opengl/geometry/juce_Matrix3D.h index 305c25f8c4..bd0929a662 100644 --- a/modules/juce_opengl/geometry/juce_Matrix3D.h +++ b/modules/juce_opengl/geometry/juce_Matrix3D.h @@ -32,6 +32,8 @@ namespace juce A 4x4 3D transformation matrix. @see Vector3D, Quaternion, AffineTransform + + @tags{OpenGL} */ template class Matrix3D diff --git a/modules/juce_opengl/geometry/juce_Quaternion.h b/modules/juce_opengl/geometry/juce_Quaternion.h index 9fac1bd7f7..b1887974f3 100644 --- a/modules/juce_opengl/geometry/juce_Quaternion.h +++ b/modules/juce_opengl/geometry/juce_Quaternion.h @@ -30,6 +30,8 @@ namespace juce //============================================================================== /** Holds a quaternion (a 3D vector and a scalar value). + + @tags{OpenGL} */ template class Quaternion diff --git a/modules/juce_opengl/geometry/juce_Vector3D.h b/modules/juce_opengl/geometry/juce_Vector3D.h index 1c92c5552b..8842662d6f 100644 --- a/modules/juce_opengl/geometry/juce_Vector3D.h +++ b/modules/juce_opengl/geometry/juce_Vector3D.h @@ -30,6 +30,8 @@ namespace juce //============================================================================== /** A three-coordinate vector. + + @tags{OpenGL} */ template class Vector3D diff --git a/modules/juce_opengl/native/juce_OpenGLExtensions.h b/modules/juce_opengl/native/juce_OpenGLExtensions.h index 23b03af2f1..acf5c9dcc8 100644 --- a/modules/juce_opengl/native/juce_OpenGLExtensions.h +++ b/modules/juce_opengl/native/juce_OpenGLExtensions.h @@ -96,6 +96,8 @@ namespace juce /** This class contains a generated list of OpenGL extension functions, which are either dynamically loaded for a specific GL context, or simply call-through to the appropriate OS function where available. + + @tags{OpenGL} */ struct OpenGLExtensionFunctions { diff --git a/modules/juce_opengl/opengl/juce_OpenGLContext.h b/modules/juce_opengl/opengl/juce_OpenGLContext.h index 64db4afeb2..4f72e4cc69 100644 --- a/modules/juce_opengl/opengl/juce_OpenGLContext.h +++ b/modules/juce_opengl/opengl/juce_OpenGLContext.h @@ -44,6 +44,8 @@ class OpenGLTexture; stop and the native resources to be freed safely. @see OpenGLRenderer + + @tags{OpenGL} */ class JUCE_API OpenGLContext { diff --git a/modules/juce_opengl/opengl/juce_OpenGLFrameBuffer.h b/modules/juce_opengl/opengl/juce_OpenGLFrameBuffer.h index 8a466ad96a..11c294a2e2 100644 --- a/modules/juce_opengl/opengl/juce_OpenGLFrameBuffer.h +++ b/modules/juce_opengl/opengl/juce_OpenGLFrameBuffer.h @@ -30,6 +30,8 @@ namespace juce //============================================================================== /** Creates an openGL frame buffer. + + @tags{OpenGL} */ class JUCE_API OpenGLFrameBuffer { diff --git a/modules/juce_opengl/opengl/juce_OpenGLGraphicsContext.h b/modules/juce_opengl/opengl/juce_OpenGLGraphicsContext.h index adf168040e..8e927f8c82 100644 --- a/modules/juce_opengl/opengl/juce_OpenGLGraphicsContext.h +++ b/modules/juce_opengl/opengl/juce_OpenGLGraphicsContext.h @@ -53,6 +53,8 @@ LowLevelGraphicsContext* createOpenGLGraphicsContext (OpenGLContext& context, Given a GL-based rendering context, you can write a fragment shader that applies some kind of per-pixel effect. + + @tags{OpenGL} */ struct JUCE_API OpenGLGraphicsContextCustomShader { diff --git a/modules/juce_opengl/opengl/juce_OpenGLHelpers.h b/modules/juce_opengl/opengl/juce_OpenGLHelpers.h index dbc683e6d1..641d7e0c2c 100644 --- a/modules/juce_opengl/opengl/juce_OpenGLHelpers.h +++ b/modules/juce_opengl/opengl/juce_OpenGLHelpers.h @@ -30,6 +30,8 @@ namespace juce //============================================================================== /** A set of miscellaneous openGL helper functions. + + @tags{OpenGL} */ class JUCE_API OpenGLHelpers { diff --git a/modules/juce_opengl/opengl/juce_OpenGLImage.h b/modules/juce_opengl/opengl/juce_OpenGLImage.h index 15b70e3059..12daac2acb 100644 --- a/modules/juce_opengl/opengl/juce_OpenGLImage.h +++ b/modules/juce_opengl/opengl/juce_OpenGLImage.h @@ -37,6 +37,8 @@ namespace juce JUCE 2D operations. @see Image, ImageType, ImagePixelData, OpenGLFrameBuffer + + @tags{OpenGL} */ class JUCE_API OpenGLImageType : public ImageType { diff --git a/modules/juce_opengl/opengl/juce_OpenGLPixelFormat.h b/modules/juce_opengl/opengl/juce_OpenGLPixelFormat.h index 3b6c83b9fb..0ddc340113 100644 --- a/modules/juce_opengl/opengl/juce_OpenGLPixelFormat.h +++ b/modules/juce_opengl/opengl/juce_OpenGLPixelFormat.h @@ -32,6 +32,8 @@ namespace juce Represents the various properties of an OpenGL pixel format. @see OpenGLContext::setPixelFormat + + @tags{OpenGL} */ class JUCE_API OpenGLPixelFormat { diff --git a/modules/juce_opengl/opengl/juce_OpenGLRenderer.h b/modules/juce_opengl/opengl/juce_OpenGLRenderer.h index 67ad2b808d..662d02dbd0 100644 --- a/modules/juce_opengl/opengl/juce_OpenGLRenderer.h +++ b/modules/juce_opengl/opengl/juce_OpenGLRenderer.h @@ -33,6 +33,8 @@ namespace juce on a background thread. @see OpenGLContext + + @tags{OpenGL} */ class JUCE_API OpenGLRenderer { diff --git a/modules/juce_opengl/opengl/juce_OpenGLShaderProgram.h b/modules/juce_opengl/opengl/juce_OpenGLShaderProgram.h index 4efbf6fbfb..865178ca78 100644 --- a/modules/juce_opengl/opengl/juce_OpenGLShaderProgram.h +++ b/modules/juce_opengl/opengl/juce_OpenGLShaderProgram.h @@ -30,6 +30,8 @@ namespace juce //============================================================================== /** Manages an OpenGL shader program. + + @tags{OpenGL} */ class JUCE_API OpenGLShaderProgram { diff --git a/modules/juce_opengl/opengl/juce_OpenGLTexture.h b/modules/juce_opengl/opengl/juce_OpenGLTexture.h index 8ced3f2faf..caecccbaf6 100644 --- a/modules/juce_opengl/opengl/juce_OpenGLTexture.h +++ b/modules/juce_opengl/opengl/juce_OpenGLTexture.h @@ -30,6 +30,8 @@ namespace juce //============================================================================== /** Creates an openGL texture from an Image. + + @tags{OpenGL} */ class JUCE_API OpenGLTexture { diff --git a/modules/juce_opengl/utils/juce_OpenGLAppComponent.h b/modules/juce_opengl/utils/juce_OpenGLAppComponent.h index ba23d04da8..51bc536a8f 100644 --- a/modules/juce_opengl/utils/juce_OpenGLAppComponent.h +++ b/modules/juce_opengl/utils/juce_OpenGLAppComponent.h @@ -34,6 +34,8 @@ namespace juce A subclass can inherit from this and implement just a few methods such as paint() and mouse-handling. The base class provides some simple abstractions to take care of continuously repainting itself. + + @tags{OpenGL} */ class JUCE_API OpenGLAppComponent : public Component, private OpenGLRenderer diff --git a/modules/juce_osc/osc/juce_OSCAddress.h b/modules/juce_osc/osc/juce_OSCAddress.h index 2ef578f681..ccddcffc02 100644 --- a/modules/juce_osc/osc/juce_OSCAddress.h +++ b/modules/juce_osc/osc/juce_OSCAddress.h @@ -42,6 +42,8 @@ namespace juce matching OSC address patterns. @see OSCMessageListener, OSCAddressPattern, OSCMessage + + @tags{OSC} */ class JUCE_API OSCAddress { @@ -92,6 +94,8 @@ private: of the message. @see OSCMessage, OSCAddress, OSCMessageListener + + @tags{OSC} */ class JUCE_API OSCAddressPattern { diff --git a/modules/juce_osc/osc/juce_OSCArgument.h b/modules/juce_osc/osc/juce_OSCArgument.h index 47c2369093..3cc649e671 100644 --- a/modules/juce_osc/osc/juce_OSCArgument.h +++ b/modules/juce_osc/osc/juce_OSCArgument.h @@ -35,6 +35,8 @@ namespace juce or blob (raw binary data). OSCMessage objects are essentially arrays of OSCArgument objects. + + @tags{OSC} */ class JUCE_API OSCArgument { diff --git a/modules/juce_osc/osc/juce_OSCBundle.h b/modules/juce_osc/osc/juce_OSCBundle.h index e9c302ac09..dfb195f7d7 100644 --- a/modules/juce_osc/osc/juce_OSCBundle.h +++ b/modules/juce_osc/osc/juce_OSCBundle.h @@ -38,6 +38,8 @@ namespace juce This is an advanced OSC structure useful to bundle OSC messages together whose effects must occur simultaneously at some given time. For most use cases it is probably enough to send and receive plain OSC messages. + + @tags{OSC} */ class JUCE_API OSCBundle { diff --git a/modules/juce_osc/osc/juce_OSCMessage.h b/modules/juce_osc/osc/juce_OSCMessage.h index cb9ff1440a..448c672462 100644 --- a/modules/juce_osc/osc/juce_OSCMessage.h +++ b/modules/juce_osc/osc/juce_OSCMessage.h @@ -35,6 +35,8 @@ namespace juce OSC messages are the elementary objects that are used to exchange any data via OSC. An OSCSender can send OSCMessage objects to an OSCReceiver. + + @tags{OSC} */ class JUCE_API OSCMessage { diff --git a/modules/juce_osc/osc/juce_OSCReceiver.h b/modules/juce_osc/osc/juce_OSCReceiver.h index a2eecd8aae..94b369b355 100644 --- a/modules/juce_osc/osc/juce_OSCReceiver.h +++ b/modules/juce_osc/osc/juce_OSCReceiver.h @@ -35,6 +35,8 @@ namespace juce It can connect to a network port, receive incoming OSC packets from the network via UDP, parse them, and forward the included OSCMessage and OSCBundle objects to its listeners. + + @tags{OSC} */ class JUCE_API OSCReceiver { diff --git a/modules/juce_osc/osc/juce_OSCSender.h b/modules/juce_osc/osc/juce_OSCSender.h index ebeadd7d1b..1ba7eade37 100644 --- a/modules/juce_osc/osc/juce_OSCSender.h +++ b/modules/juce_osc/osc/juce_OSCSender.h @@ -33,7 +33,9 @@ namespace juce An OSCSender object can connect to a network port. It then can send OSC messages and bundles to a specified host over an UDP socket. - */ + + @tags{OSC} +*/ class JUCE_API OSCSender { public: diff --git a/modules/juce_osc/osc/juce_OSCTimeTag.h b/modules/juce_osc/osc/juce_OSCTimeTag.h index 5a2aa4c207..29a5a0377b 100644 --- a/modules/juce_osc/osc/juce_OSCTimeTag.h +++ b/modules/juce_osc/osc/juce_OSCTimeTag.h @@ -44,6 +44,8 @@ namespace juce For a more user-friendly time format, convert OSCTimeTag to a juce::Time object using toTime(). + + @tags{OSC} */ class JUCE_API OSCTimeTag { diff --git a/modules/juce_osc/osc/juce_OSCTypes.h b/modules/juce_osc/osc/juce_OSCTypes.h index 83dbee30af..3f657a8deb 100644 --- a/modules/juce_osc/osc/juce_OSCTypes.h +++ b/modules/juce_osc/osc/juce_OSCTypes.h @@ -43,6 +43,8 @@ typedef Array OSCTypeList; Note: this implementation does not support any additional type tags that are not part of the specification. + + @tags{OSC} */ class JUCE_API OSCTypes { @@ -63,6 +65,8 @@ public: //============================================================================== /** Base class for exceptions that can be thrown by methods in the OSC module. + + @tags{OSC} */ struct OSCException : public std::exception { @@ -80,6 +84,8 @@ struct OSCException : public std::exception //============================================================================== /** Exception type thrown when the OSC module fails to parse something because of a data format not compatible with the OpenSoundControl 1.0 specification. + + @tags{OSC} */ struct OSCFormatError : public OSCException { @@ -91,6 +97,8 @@ struct OSCFormatError : public OSCException Note: this should never happen, and all the places where this is thrown should have a preceding jassertfalse to facilitate debugging. + + @tags{OSC} */ struct OSCInternalError : public OSCException { diff --git a/modules/juce_product_unlocking/in_app_purchases/juce_InAppPurchases.h b/modules/juce_product_unlocking/in_app_purchases/juce_InAppPurchases.h index 93409591f4..5558ccba7a 100644 --- a/modules/juce_product_unlocking/in_app_purchases/juce_InAppPurchases.h +++ b/modules/juce_product_unlocking/in_app_purchases/juce_InAppPurchases.h @@ -35,6 +35,8 @@ namespace juce any previously pending transactions will be resumed. Once an InAppPurchases object is created, call addListener() to attach listeners. + + @tags{ProductUnlocking} */ class JUCE_API InAppPurchases : private DeletedAtShutdown { @@ -126,6 +128,7 @@ public: /** Called whenever a product info is returned after a call to InAppPurchases::getProductsInformation(). */ virtual void productsInfoReturned (const Array& /*products*/) {} + /** Structure holding purchase information */ struct PurchaseInfo { Purchase purchase; diff --git a/modules/juce_product_unlocking/marketplace/juce_KeyFileGeneration.h b/modules/juce_product_unlocking/marketplace/juce_KeyFileGeneration.h index 7e06c6e798..4b86038404 100644 --- a/modules/juce_product_unlocking/marketplace/juce_KeyFileGeneration.h +++ b/modules/juce_product_unlocking/marketplace/juce_KeyFileGeneration.h @@ -30,6 +30,8 @@ namespace juce /** Contains static utilities for generating key-files that can be unlocked by the OnlineUnlockStatus class. + + @tags{ProductUnlocking} */ class JUCE_API KeyGeneration { diff --git a/modules/juce_product_unlocking/marketplace/juce_OnlineUnlockForm.h b/modules/juce_product_unlocking/marketplace/juce_OnlineUnlockForm.h index f1cc22b1dc..c58ba5267c 100644 --- a/modules/juce_product_unlocking/marketplace/juce_OnlineUnlockForm.h +++ b/modules/juce_product_unlocking/marketplace/juce_OnlineUnlockForm.h @@ -45,6 +45,8 @@ namespace juce if you need to get rid of it sooner. @see OnlineUnlockStatus + + @tags{ProductUnlocking} */ class JUCE_API OnlineUnlockForm : public Component, private Button::Listener diff --git a/modules/juce_product_unlocking/marketplace/juce_OnlineUnlockStatus.h b/modules/juce_product_unlocking/marketplace/juce_OnlineUnlockStatus.h index 3b0c4beb39..f82c69bf64 100644 --- a/modules/juce_product_unlocking/marketplace/juce_OnlineUnlockStatus.h +++ b/modules/juce_product_unlocking/marketplace/juce_OnlineUnlockStatus.h @@ -53,6 +53,8 @@ namespace juce register, see the OnlineUnlockForm class. @see OnlineUnlockForm, KeyGeneration + + @tags{ProductUnlocking} */ class JUCE_API OnlineUnlockStatus { diff --git a/modules/juce_product_unlocking/marketplace/juce_TracktionMarketplaceStatus.h b/modules/juce_product_unlocking/marketplace/juce_TracktionMarketplaceStatus.h index 1e5cedc8bf..114dc51203 100644 --- a/modules/juce_product_unlocking/marketplace/juce_TracktionMarketplaceStatus.h +++ b/modules/juce_product_unlocking/marketplace/juce_TracktionMarketplaceStatus.h @@ -36,6 +36,8 @@ namespace juce implement all the pure virtual methods to tell it about your product. @see OnlineUnlockStatus, OnlineUnlockForm, KeyGeneration + + @tags{ProductUnlocking} */ class JUCE_API TracktionMarketplaceStatus : public OnlineUnlockStatus { diff --git a/modules/juce_video/capture/juce_CameraDevice.h b/modules/juce_video/capture/juce_CameraDevice.h index 6c11e22ed1..57ac1a0400 100644 --- a/modules/juce_video/capture/juce_CameraDevice.h +++ b/modules/juce_video/capture/juce_CameraDevice.h @@ -38,6 +38,8 @@ namespace juce system, then call openDevice to open one for use. Once you have a CameraDevice object, you can get a viewer component from it, and use its methods to stream to a file or capture still-frames. + + @tags{Video} */ class JUCE_API CameraDevice { diff --git a/modules/juce_video/playback/juce_VideoComponent.h b/modules/juce_video/playback/juce_VideoComponent.h index ea08878039..0f4403c87c 100644 --- a/modules/juce_video/playback/juce_VideoComponent.h +++ b/modules/juce_video/playback/juce_VideoComponent.h @@ -34,6 +34,8 @@ namespace juce Use the load() method to open a video once you've added this component to a parent (or put it on the desktop). + + @tags{Video} */ class JUCE_API VideoComponent : public Component, private Timer