Skip to content

Proposal:Update AppLocalizations iOS Documentation #184916

Description

@ad-angelo

The generated iOS documentation of the AppLocalizations class is out dated and does not match the documentation on the Flutter website : Localizing for iOS: Updating the iOS app bundle.

Actual documentation :

/// ## iOS Applications
///
/// iOS applications define key application metadata, including supported
/// locales, in an Info.plist file that is built into the application bundle.
/// To configure the locales supported by your app, you’ll need to edit this
/// file.
///
/// First, open your project’s ios/Runner.xcworkspace Xcode workspace file.
/// Then, in the Project Navigator, open the Info.plist file under the Runner
/// project’s Runner folder.
///
/// Next, select the Information Property List item, select Add Item from the
/// Editor menu, then select Localizations from the pop-up menu.
///
/// Select and expand the newly-created Localizations item then, for each
/// locale your application supports, add a new item and select the locale
/// you wish to add from the pop-up menu in the Value field. This list should
/// be consistent with the languages listed in the @(class).supportedLocales
/// property.

Documentation proposal :

/// ## iOS Applications
///
/// To ensure the App Store entry correctly displays the supported
/// languages, add the supported languages in the Xcode project.
///
/// To configure the locales supported by the app, follow these instructions:
///
/// 1. Open your project's `ios/Runner.xcodeproj` Xcode file.
///
/// 2. In the **Project Navigator**, select the `Runner` project
///    file under **Projects**.
///
/// 3. Select the `Info` tab in the project editor.
///
/// 4. In the **Localizations** section, click the `Add` button
///    (`+`) to add the supported languages and regions to your
///    project.
///
/// This list should be consistent with the languages listed in the
/// @(class).supportedLocales property.

Metadata

Metadata

Assignees

No one assigned

    Labels

    P3Issues that are less important to the Flutter projectc: proposalA detailed proposal for a change to Flutterd: api docsIssues with https://api.flutter.dev/team-toolOwned by Flutter Tool teamtoolAffects the "flutter" command-line tool. See also t: labels.triaged-toolTriaged by Flutter Tool team

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions