tilera/nyxx
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Fix doc strings

Browse source 
[ci skip]
This commit is contained in:
Szymon Uglis 2020-06-23 23:39:22 +02:00
parent 91c42084b7
commit 065a9bba7c
2 changed files with 9 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
nyxx/lib/src/core/channel/ITextChannel.dart
View file

@ -9,37 +9,35 @@ abstract class ITextChannel implements Channel, MessageChannel {
/// Sends message to channel. Performs `toString()` on thing passed to [content]. Allows to send embeds with [embed] field.
///
/// ```
/// await chan.send(content: "Very nice message!");
/// await channel.send(content: "Very nice message!");
/// ```
///
/// Can be used in combination with [Emoji]. Just run `toString()` on [Emoji] instance:
/// ```
/// var emoji = guild.emojis.values.firstWhere((e) => e.name.startsWith("dart"));
/// await chan.send(content: "Dart is superb! ${emoji.toString()}");
/// final emoji = guild.emojis.findOne((e) => e.name.startsWith("dart"));
/// await channel.send(content: "Dart is superb! ${emoji.toString()}");
/// ```
/// Embeds can be sent very easily:
/// ```
/// var embed = new EmbedBuilder()
/// var embed = EmbedBuilder()
/// ..title = "Example Title"
/// ..addField(name: "Memory usage", value: "${ProcessInfo.currentRss / 1024 / 1024}MB");
///
/// await chan.send(embed: embed);
/// ```
///
///
/// Method also allows to send file and optional [content] with [embed].
/// Use `expandAttachment(String file)` method to expand file names in embed
///
/// ```
/// await chan.send(files: [new File("kitten.png"), new File("kitten.jpg")], content: "Kittens ^-^"]);
/// await channel.send(files: [new File("kitten.png"), new File("kitten.jpg")], content: "Kittens ^-^"]);
/// ```
/// ```
/// var embed = new nyxx.EmbedBuilder()
/// ..title = "Example Title"
/// ..thumbnailUrl = "${attach("kitten.jpg")}";
///
/// await e.message.channel
/// .send(files: [new File("kitten.jpg")], embed: embed, content: "HEJKA!");
/// channel.send(files: [new File("kitten.jpg")], embed: embed, content: "HEJKA!");
/// ```
@override
Future<Message> send(

6
nyxx/lib/src/core/channel/guild/GuildChannel.dart
View file

@ -44,7 +44,7 @@ abstract class IGuildChannel extends Channel {
/// Creates new [Invite] for [Channel] and returns it"s instance
///
/// ```
/// var inv = await chan.createInvite(maxUses: 2137);
/// var invite = await channel.createInvite(maxUses: 2137);
/// ```
Future<Invite> createInvite({int? maxAge, int? maxUses, bool? temporary, bool? unique, String? auditReason});
}
@ -109,7 +109,7 @@ abstract class CachelessGuildChannel extends IGuildChannel {
}
}
/// Allows to set permissions for channel. [entity] can be either User or Role
/// Allows to set permissions for channel. [entity] can be either [User] or [Role]
/// Throws if [entity] isn't [User] or [Role]
@override
Future<void> editChannelPermissions(PermissionsBuilder perms, SnowflakeEntity entity, {String? auditReason}) async {
@ -152,7 +152,7 @@ abstract class CachelessGuildChannel extends IGuildChannel {
._execute(BasicRequest._new("/channels/${this.id}/permissions/$id", method: "PUT", auditLog: auditReason));
}
/// Creates new [Invite] for [Channel] and returns it"s instance
/// Creates new [Invite] for [Channel] and returns it's instance
///
/// ```
/// final invite = await channel.createInvite(maxUses: 2137);