1
0
mirror of https://github.com/cookiengineer/audacity synced 2026-03-26 16:15:53 +01:00

Much Doxygen commentary for Track.h...

... Comments and indentation changes only, with a small bit of code movement to
improve the sequence of items on the Doxygen page.

Comments some obscurities of template usage and of iterators (TrackIter and
TrackNodePointer).
This commit is contained in:
Paul Licameli
2020-08-23 07:51:01 -04:00
parent 372393f49e
commit d420fdecf4
2 changed files with 229 additions and 156 deletions

View File

@@ -9,7 +9,7 @@
*******************************************************************//**
\class Track
\brief Fundamental data object of Audacity, placed in the TrackPanel.
\brief Fundamental data object of Audacity, displayed in the TrackPanel.
Classes derived form it include the WaveTrack, NoteTrack, LabelTrack
and TimeTrack.
@@ -800,8 +800,9 @@ TrackNodePointer TrackList::Remove(Track *t)
void TrackList::Clear(bool sendEvent)
{
// Null out the back-pointers in tracks, in case there are outstanding
// shared_ptrs to those tracks.
// Null out the back-pointers to this in tracks, in case there
// are outstanding shared_ptrs to those tracks, making them outlive
// the temporary ListOfTracks below.
for ( auto pTrack: *this )
pTrack->SetOwner( {}, {} );
for ( auto pTrack: mPendingUpdates )