Skip to content

Commit

Permalink
docs: update doc comments
Browse files Browse the repository at this point in the history
  • Loading branch information
Tienisto committed Jan 21, 2024
1 parent 6686787 commit 4bc9509
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
4 changes: 2 additions & 2 deletions slang/lib/builder/builder/translation_map_builder.dart
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ import 'package:slang/builder/model/translation_map.dart';
class TranslationMapBuilder {
/// This method transforms files to an intermediate model [TranslationMap].
/// After this step,
/// - we ignore the environment (i.e. dart:io, build_runner)
/// - we ignore the file type (JSON, YAML, CSV) because everything is a map now
/// - we removed the environment (i.e. dart:io, build_runner)
/// - we removed the file type (JSON, YAML, CSV) because everything is a map now
///
/// The resulting map is in a unmodified state, so no actual i18n handling (plural, rich text) has been applied.
static Future<TranslationMap> build({
Expand Down
3 changes: 3 additions & 0 deletions slang/lib/builder/model/slang_file_collection.dart
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ import 'package:slang/builder/model/i18n_locale.dart';
import 'package:slang/builder/model/raw_config.dart';
import 'package:slang/builder/utils/path_utils.dart';

/// A collection of translation files that can be read in a later step.
/// This is an abstraction to support build_runner and the custom CLI by
/// providing a common [FileReader] interface.
class SlangFileCollection {
final RawConfig config;
final List<TranslationFile> files;
Expand Down

0 comments on commit 4bc9509

Please sign in to comment.