Browse Source

Docs: flatten the references section

tags/v1.0.0
Chris Smith 5 years ago
parent
commit
ccf874d89f
1 changed files with 61 additions and 64 deletions
  1. 61
    64
      docs/index.adoc

+ 61
- 64
docs/index.adoc View File

172
 which are documented in the <<Messages>> reference. Other useful methods
172
 which are documented in the <<Messages>> reference. Other useful methods
173
 such as `reply` can be found in the <<Utility methods>> reference.
173
 such as `reply` can be found in the <<Utility methods>> reference.
174
 
174
 
175
-== Reference
176
-
177
-=== IrcClient DSL
175
+== IrcClient DSL
178
 
176
 
179
 The DSL for creating a new `IrcClient` allows you to set a number of
177
 The DSL for creating a new `IrcClient` allows you to set a number of
180
 options relating to how KtIrc connects, what user details it provides,
178
 options relating to how KtIrc connects, what user details it provides,
208
 }
206
 }
209
 ----
207
 ----
210
 
208
 
211
-==== Server settings
209
+=== Server settings
212
 
210
 
213
 The server block allows you to specify the details of the IRC server you
211
 The server block allows you to specify the details of the IRC server you
214
 wish to connect to:
212
 wish to connect to:
235
 }
233
 }
236
 ----
234
 ----
237
 
235
 
238
-==== User profile
236
+=== User profile
239
 
237
 
240
 The user profile controls how KtIrc will present itself to the IRC server, and
238
 The user profile controls how KtIrc will present itself to the IRC server, and
241
 how other users on that server will see the KtIrc user:
239
 how other users on that server will see the KtIrc user:
261
 profile("nickname", "username", "real name")
259
 profile("nickname", "username", "real name")
262
 ----
260
 ----
263
 
261
 
264
-==== Behaviour
262
+=== Behaviour
265
 
263
 
266
 The behaviour block allows you to tweak how KtIrc itself operates. These
264
 The behaviour block allows you to tweak how KtIrc itself operates. These
267
 options allow you perform common operations automatically, or enjoy more
265
 options allow you perform common operations automatically, or enjoy more
276
 
274
 
277
 The behaviour block is optional in its entirety.
275
 The behaviour block is optional in its entirety.
278
 
276
 
279
-==== SASL configuration
277
+=== SASL configuration
280
 
278
 
281
 SASL ("Simple Authentication and Security Layer") is a standard mechanism
279
 SASL ("Simple Authentication and Security Layer") is a standard mechanism
282
 for securely authenticating to a service that has recently been adopted
280
 for securely authenticating to a service that has recently been adopted
360
 
358
 
361
 The SASL block is optional in its entirety.
359
 The SASL block is optional in its entirety.
362
 
360
 
363
-=== State
361
+== State
364
 
362
 
365
 KtIrc attempts to track all reasonable state of the IRC network. This includes
363
 KtIrc attempts to track all reasonable state of the IRC network. This includes
366
 details about the server, channels the client is joined to, and users that are
364
 details about the server, channels the client is joined to, and users that are
367
 also in those channels. The state is exposed in a several fields accessible
365
 also in those channels. The state is exposed in a several fields accessible
368
 from the `IrcClient`:
366
 from the `IrcClient`:
369
 
367
 
370
-==== ServerState
368
+=== ServerState
371
 
369
 
372
 The server state provides information about the server, and our connection to
370
 The server state provides information about the server, and our connection to
373
 it.
371
 it.
423
 Contains the types of channels that are allowed by the server, such as
421
 Contains the types of channels that are allowed by the server, such as
424
 `\#&amp;` for normal channels ("#") and local channels ("&").
422
 `\#&amp;` for normal channels ("#") and local channels ("&").
425
 
423
 
426
-===== Capabilities
424
+==== Capabilities
427
 
425
 
428
 The IRCv3 specifications introduce the concept of 'capability negotiation'.
426
 The IRCv3 specifications introduce the concept of 'capability negotiation'.
429
 This allows the client and server to negotiate and enable new capabilities
427
 This allows the client and server to negotiate and enable new capabilities
454
 Contains a map of capabilities that KtIrc has successfully negotiated with
452
 Contains a map of capabilities that KtIrc has successfully negotiated with
455
 the server.
453
 the server.
456
 
454
 
457
-====== Supported capabilities
455
+===== Supported capabilities
458
 
456
 
459
 * `sasl` - used to perform SASL authentication during connection
457
 * `sasl` - used to perform SASL authentication during connection
460
 * `message-tags` - allows arbitrary tags on messages
458
 * `message-tags` - allows arbitrary tags on messages
471
 * `away-notify` - the server sends a message when a user's away state changes
469
 * `away-notify` - the server sends a message when a user's away state changes
472
 * `chghost` - the server sends a message when a user's host changes
470
 * `chghost` - the server sends a message when a user's host changes
473
 
471
 
474
-===== Features
472
+==== Features
475
 
473
 
476
 Features are KtIrc's way of exposing the information the server declares in
474
 Features are KtIrc's way of exposing the information the server declares in
477
 its ISUPPORT messages. These describe how the server is configured, and what
475
 its ISUPPORT messages. These describe how the server is configured, and what
503
 `Int?` or `String?` types).
501
 `Int?` or `String?` types).
504
 ====
502
 ====
505
 
503
 
506
-==== UserState
504
+=== UserState
507
 
505
 
508
 The client's UserState object tracks the details of all users in common
506
 The client's UserState object tracks the details of all users in common
509
 channels. It can be used to find the most up-to-date and comprehensive
507
 channels. It can be used to find the most up-to-date and comprehensive
544
 <3> Returns all common channels we share with the user; will never
542
 <3> Returns all common channels we share with the user; will never
545
     include channels that the KtIrc client is not joined to.
543
     include channels that the KtIrc client is not joined to.
546
 
544
 
547
-==== ChannelState
545
+=== ChannelState
548
 
546
 
549
 The ChannelState keeps track of the state for all channels that the client
547
 The ChannelState keeps track of the state for all channels that the client
550
 is joined to. It is indexed by channel name:
548
 is joined to. It is indexed by channel name:
570
 * `modes` - A map of the current channel modes and their values. Only
568
 * `modes` - A map of the current channel modes and their values. Only
571
   complete if `modesDiscovered` is true.
569
   complete if `modesDiscovered` is true.
572
 
570
 
573
-===== Channel users
571
+==== Channel users
574
 
572
 
575
 Channel users are accessed using the `users` property, which provides an
573
 Channel users are accessed using the `users` property, which provides an
576
 iterable map of nickname to `ChannelUser`. Each `ChannelUser` contains
574
 iterable map of nickname to `ChannelUser`. Each `ChannelUser` contains
585
 }
583
 }
586
 ----
584
 ----
587
 
585
 
588
-=== Events
586
+== Events
589
 
587
 
590
 Incoming lines from the IRC server are covered by KtIrc to subclasses of
588
 Incoming lines from the IRC server are covered by KtIrc to subclasses of
591
 `IrcEvent`. These, along with other more advance events, are then published
589
 `IrcEvent`. These, along with other more advance events, are then published
658
 All the properties are nullable, and most events will only populate
656
 All the properties are nullable, and most events will only populate
659
 one of the three.
657
 one of the three.
660
 
658
 
661
-==== Server events
659
+=== Server events
662
 
660
 
663
-===== ServerConnecting
661
+==== ServerConnecting
664
 * Type: IrcEvent
662
 * Type: IrcEvent
665
 * Properties: _(none)_
663
 * Properties: _(none)_
666
 
664
 
668
 a server. It will be followed by either a <<ServerConnected>> or a
666
 a server. It will be followed by either a <<ServerConnected>> or a
669
 <<ServerConnectionError>> event at some point.
667
 <<ServerConnectionError>> event at some point.
670
 
668
 
671
-===== ServerConnected
669
+==== ServerConnected
672
 * Type: IrcEvent
670
 * Type: IrcEvent
673
 * Properties: _(none)_
671
 * Properties: _(none)_
674
 
672
 
677
 The server will *not* yet be ready for use - a <<ServerReady>> event will
675
 The server will *not* yet be ready for use - a <<ServerReady>> event will
678
 follow once all of the initial setup has completed.
676
 follow once all of the initial setup has completed.
679
 
677
 
680
-===== ServerConnectionError
678
+==== ServerConnectionError
681
 * Type: IrcEvent
679
 * Type: IrcEvent
682
 * Properties:
680
 * Properties:
683
 ** `error`: `ConnectionError` - the type of error that occurred
681
 ** `error`: `ConnectionError` - the type of error that occurred
697
 
695
 
698
 This event will be followed by a <<ServerDisconnected>> event.
696
 This event will be followed by a <<ServerDisconnected>> event.
699
 
697
 
700
-===== ServerWelcome
698
+==== ServerWelcome
701
 * Type: IrcEvent
699
 * Type: IrcEvent
702
 * Properties:
700
 * Properties:
703
 ** `server`: `String` - the name the server supplied for itself
701
 ** `server`: `String` - the name the server supplied for itself
710
 identifies itself as `node3.uk.irc.example.com`), and the nickname
708
 identifies itself as `node3.uk.irc.example.com`), and the nickname
711
 that the server says we are using.
709
 that the server says we are using.
712
 
710
 
713
-===== ServerFeaturesUpdated
711
+==== ServerFeaturesUpdated
714
 * Type: IrcEvent
712
 * Type: IrcEvent
715
 * Properties:
713
 * Properties:
716
 ** `serverFeatures`: `ServerFeatureMap` - the features supplied by the server
714
 ** `serverFeatures`: `ServerFeatureMap` - the features supplied by the server
722
 In general, you should wait for a <<ServerReady>> event and then query the
720
 In general, you should wait for a <<ServerReady>> event and then query the
723
 <<Features>> instead of relying on this event.
721
 <<Features>> instead of relying on this event.
724
 
722
 
725
-===== ServerReady
723
+==== ServerReady
726
 * Type: IrcEvent
724
 * Type: IrcEvent
727
 * Properties: _(none)_
725
 * Properties: _(none)_
728
 
726
 
733
 At this point it is safe to start issuing commands, checking
731
 At this point it is safe to start issuing commands, checking
734
 state, joining channels, etc.
732
 state, joining channels, etc.
735
 
733
 
736
-===== PingReceived
734
+==== PingReceived
737
 * Type: IrcEvent
735
 * Type: IrcEvent
738
 * Properties:
736
 * Properties:
739
 ** `nonce`: `ByteArray` - the unique data that must be included in the reply
737
 ** `nonce`: `ByteArray` - the unique data that must be included in the reply
741
 Raised when the IRC server sends a PING message to the client. KtIrc will
739
 Raised when the IRC server sends a PING message to the client. KtIrc will
742
 automatically reply with an appropriate PONG.
740
 automatically reply with an appropriate PONG.
743
 
741
 
744
-===== ServerCapabilitiesReceived
742
+==== ServerCapabilitiesReceived
745
 
743
 
746
 TODO
744
 TODO
747
 
745
 
748
-===== ServerCapabilitiesAcknowledged
746
+==== ServerCapabilitiesAcknowledged
749
 
747
 
750
 TODO
748
 TODO
751
 
749
 
752
-===== ServerCapabilitiesFinished
750
+==== ServerCapabilitiesFinished
753
 
751
 
754
 TODO
752
 TODO
755
 
753
 
756
-===== MotdLineReceived
754
+==== MotdLineReceived
757
 
755
 
758
 TODO
756
 TODO
759
 
757
 
760
-===== MotdFinished
758
+==== MotdFinished
761
 
759
 
762
 TODO
760
 TODO
763
 
761
 
764
-==== Channel events
762
+=== Channel events
765
 
763
 
766
-===== ChannelJoined
764
+==== ChannelJoined
767
 
765
 
768
 TODO
766
 TODO
769
 
767
 
770
-===== ChannelJoinFailed
768
+==== ChannelJoinFailed
771
 
769
 
772
 TODO
770
 TODO
773
 
771
 
774
-===== ChannelParted
772
+==== ChannelParted
775
 
773
 
776
 TODO
774
 TODO
777
 
775
 
778
-===== ChannelUserKicked
776
+==== ChannelUserKicked
779
 
777
 
780
 TODO
778
 TODO
781
 
779
 
782
-===== ChannelQuit
780
+==== ChannelQuit
783
 
781
 
784
 TODO
782
 TODO
785
 
783
 
786
-===== ChannelNickChanged
784
+==== ChannelNickChanged
787
 
785
 
788
 TODO
786
 TODO
789
 
787
 
790
-===== ChannelNamesReceived
788
+==== ChannelNamesReceived
791
 
789
 
792
 TODO
790
 TODO
793
 
791
 
794
-===== ChannelNamesFinished
792
+==== ChannelNamesFinished
795
 
793
 
796
 TODO
794
 TODO
797
 
795
 
798
-===== ChannelTopicDiscovered
796
+==== ChannelTopicDiscovered
799
 
797
 
800
 TODO
798
 TODO
801
 
799
 
802
-===== ChannelTopicMetadataDiscovered
800
+==== ChannelTopicMetadataDiscovered
803
 
801
 
804
 TODO
802
 TODO
805
 
803
 
806
-===== ChannelTopicChanged
804
+==== ChannelTopicChanged
807
 
805
 
808
 TODO
806
 TODO
809
 
807
 
810
 
808
 
811
-==== Channel/User events
809
+=== Channel/User events
812
 
810
 
813
 TODO
811
 TODO
814
 
812
 
815
-===== MessageReceived
813
+==== MessageReceived
816
 
814
 
817
 TODO
815
 TODO
818
 
816
 
819
-===== NoticeReceived
817
+==== NoticeReceived
820
 
818
 
821
 TODO
819
 TODO
822
 
820
 
823
-===== ActionReceived
821
+==== ActionReceived
824
 
822
 
825
 TODO
823
 TODO
826
 
824
 
827
-===== CtcpReceived
825
+==== CtcpReceived
828
 
826
 
829
 TODO
827
 TODO
830
 
828
 
831
-===== CtcpReplyReceived
829
+==== CtcpReplyReceived
832
 
830
 
833
 TODO
831
 TODO
834
 
832
 
835
-===== UserQuit
833
+==== UserQuit
836
 
834
 
837
 TODO
835
 TODO
838
 
836
 
839
-===== UserNickChanged
837
+==== UserNickChanged
840
 
838
 
841
 TODO
839
 TODO
842
 
840
 
843
-===== UserHostChanged
841
+==== UserHostChanged
844
 
842
 
845
 TODO
843
 TODO
846
 
844
 
847
-===== UserAccountChanged
845
+==== UserAccountChanged
848
 
846
 
849
 TODO
847
 TODO
850
 
848
 
851
-===== ModeChanged
849
+==== ModeChanged
852
 
850
 
853
 TODO
851
 TODO
854
 
852
 
855
 
853
 
856
-==== Other events
854
+=== Other events
857
 
855
 
858
-===== AuthenticationMessage
856
+==== AuthenticationMessage
859
 
857
 
860
 TODO
858
 TODO
861
 
859
 
862
-===== SaslFinished
860
+==== SaslFinished
863
 
861
 
864
 TODO
862
 TODO
865
 
863
 
866
-===== SaslMechanismNotAvailableError
864
+==== SaslMechanismNotAvailableError
867
 
865
 
868
 TODO
866
 TODO
869
 
867
 
870
-===== BatchStarted
868
+==== BatchStarted
871
 
869
 
872
 TODO
870
 TODO
873
 
871
 
874
-===== BatchFinished
872
+==== BatchFinished
875
 
873
 
876
 TODO
874
 TODO
877
 
875
 
878
-===== BatchReceived
876
+==== BatchReceived
879
 
877
 
880
 TODO
878
 TODO
881
 
879
 
882
-===== NicknameChangeFailed
880
+==== NicknameChangeFailed
883
 
881
 
884
 TODO
882
 TODO
885
 
883
 
886
-
887
-=== Messages
884
+== Messages
888
 
885
 
889
 TODO
886
 TODO
890
 
887
 
891
-=== Utility methods
888
+== Utility methods
892
 
889
 
893
 TODO
890
 TODO
894
 
891
 
895
-=== IRCv3 support
892
+== IRCv3 support
896
 
893
 
897
 TODO
894
 TODO

Loading…
Cancel
Save