Skip to content

Commit

Permalink
Fix documentation errors.
Browse files Browse the repository at this point in the history
  • Loading branch information
amugofjava committed Feb 22, 2024
1 parent a3e8701 commit fe936e8
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 10 deletions.
3 changes: 3 additions & 0 deletions lib/services/podcast/podcast_service.dart
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ import 'package:anytime/services/settings/settings_service.dart';
import 'package:anytime/state/episode_state.dart';
import 'package:podcast_search/podcast_search.dart' as pcast;

/// The [PodcastService] handles interactions around podcasts including searching, fetching
/// the trending/charts podcasts, loading the podcast RSS feed and anciallary items such as
/// chapters and transcripts.
abstract class PodcastService {
final PodcastApi api;
final Repository repository;
Expand Down
2 changes: 1 addition & 1 deletion lib/services/settings/mobile_settings_service.dart
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import 'package:anytime/services/settings/settings_service.dart';
import 'package:rxdart/rxdart.dart';
import 'package:shared_preferences/shared_preferences.dart';

/// An implementation [SettingService] for mobile devices backed by
/// An implementation [SettingsService] for mobile devices backed by
/// shared preferences.
class MobileSettingsService extends SettingsService {
static late SharedPreferences _sharedPreferences;
Expand Down
4 changes: 2 additions & 2 deletions lib/ui/podcast/funding_menu.dart
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ import 'package:url_launcher/url_launcher.dart';

/// This class is responsible for rendering the funding menu on the podcast details page.
///
/// It returns either a [_MaterialPodcastMenu] or a [_CupertinoContextMenu]
/// instance depending upon which platform we are running on.
/// It returns either a Material or Cupertino style menu instance depending upon which
/// platform we are running on.
///
/// The target platform is based on the current [Theme]: [ThemeData.platform].
class FundingMenu extends StatelessWidget {
Expand Down
4 changes: 2 additions & 2 deletions lib/ui/podcast/now_playing_options.dart
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ import 'package:provider/provider.dart';
/// issue whereby the scroll view and [DraggableScrollableSheet] clash and therefore cannot
/// be used together.
///
/// See issues (64157)[https://github.com/flutter/flutter/issues/64157]
/// (67219)[https://github.com/flutter/flutter/issues/67219]
/// See issues [64157](https://github.com/flutter/flutter/issues/64157)
/// [67219](https://github.com/flutter/flutter/issues/67219)
///
/// If anyone can come up with a more elegant solution (and one that does not throw
/// an overflow error in debug) please raise and issue/submit a PR.
Expand Down
2 changes: 1 addition & 1 deletion lib/ui/widgets/episode_tile.dart
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ import 'package:flutter_dialogs/flutter_dialogs.dart';
import 'package:intl/intl.dart' show DateFormat;
import 'package:provider/provider.dart';

/// An EpisodeTitle is built with an [ExpandedTile] widget and displays the episode's
/// An EpisodeTitle is built with an [ExpansionTile] widget and displays the episode's
/// basic details, thumbnail and play button.
///
/// It can then be expanded to present addition information about the episode and further
Expand Down
8 changes: 4 additions & 4 deletions lib/ui/widgets/podcast_image.dart
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ import 'package:flutter/material.dart';
/// and error placeholder can be specified which will be rendered whilst the image is loading
/// or has failed to load.
///
/// We cache the image at a fixed sized of [cacheHeight] and [cacheWidth] regardlessof render
/// size. By doing this, large podcast artwork will not slow the application down and the same
/// image rendered at different sizes will return the same cache hit reducing the need for
/// fetching the image several times for differing render sizes.
/// We cache the image at a fixed sized of 480 regardless of render size. By doing this, large
/// podcast artwork will not slow the application down and the same image rendered at different
/// sizes will return the same cache hit reducing the need for fetching the image several times
/// for differing render sizes.
// ignore: must_be_immutable
class PodcastImage extends StatefulWidget {
final String url;
Expand Down

0 comments on commit fe936e8

Please sign in to comment.