[io/doc] Update Link.createSync() documentation to be in accordance with Link.create()

Bug: https://github.com/dart-lang/sdk/issues/30665
Bug: https://github.com/dart-lang/sdk/issues/52972
Change-Id: I7e0ef87151bee7b371335933bd1b8ab1ebd72e52
CoreLibraryReviewExempt: documentation update
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/329321
Reviewed-by: Alexander Aprelev <aam@google.com>
Commit-Queue: Alexander Thomas <athom@google.com>
Reviewed-by: Brian Quinlan <bquinlan@google.com>
Reviewed-by: Alexander Thomas <athom@google.com>
This commit is contained in:
Sergey G. Grekhov 2023-10-11 14:24:38 +00:00 committed by Commit Queue
parent 9a4c9100ae
commit f05bf93d3f

View file

@ -72,9 +72,14 @@ abstract interface class Link implements FileSystemEntity {
/// the path of [target] are not affected, unless they are also in [path].
///
/// On the Windows platform, this call will create a true symbolic link
/// instead of a Junction. In order to create a symbolic link on Windows, Dart
/// must be run in Administrator mode or the system must have Developer Mode
/// enabled, otherwise a [FileSystemException] will be raised with
/// instead of a junction. The link represents a file or directory and
/// does not change its type after creation. If [target] exists then
/// the type of the link will match the type [target], otherwise a file
/// symlink is created.
///
/// In order to create a symbolic link on Windows, Dart must be run in
/// Administrator mode or the system must have Developer Mode enabled,
/// otherwise a [FileSystemException] will be raised with
/// `ERROR_PRIVILEGE_NOT_HELD` set as the errno when this call is made.
///
/// On other platforms, the POSIX `symlink()` call is used to make a symbolic