aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMatias Linares <matiaslina@gmail.com>2021-01-11 22:19:00 -0300
committerMatias Linares <matiaslina@gmail.com>2021-01-11 22:19:00 -0300
commit9da9134f0b28c0e4c69537b54fd96dca3a66aaed (patch)
tree46a14da15beb95dd6f2c6b995b2dc6e7b6e94970 /docs
parente5e5211aab9e6c579eeb6e78673015dcc03bb666 (diff)
downloadperl6-matrix-client-9da9134f0b28c0e4c69537b54fd96dca3a66aaed.tar.gz
[DOC] .pod6 -> .rakudoc extension & better layout
Diffstat (limited to 'docs')
-rw-r--r--docs/Matrix/Client.rakudoc (renamed from docs/client.pod6)0
-rw-r--r--docs/Matrix/Client/Exception.rakudoc52
-rw-r--r--docs/Matrix/Client/Requester.rakudoc (renamed from docs/requester.pod6)3
-rw-r--r--docs/Matrix/Client/Response.rakudoc (renamed from docs/responses.pod6)1
-rw-r--r--docs/Matrix/Client/Room.rakudoc (renamed from docs/room.pod6)0
-rw-r--r--docs/basics.rakudoc (renamed from docs/basics.pod6)0
-rw-r--r--docs/usage.rakudoc (renamed from docs/usage.pod6)0
-rw-r--r--docs/x-matrix-response.pod623
8 files changed, 53 insertions, 26 deletions
diff --git a/docs/client.pod6 b/docs/Matrix/Client.rakudoc
index ba1f2e1..ba1f2e1 100644
--- a/docs/client.pod6
+++ b/docs/Matrix/Client.rakudoc
diff --git a/docs/Matrix/Client/Exception.rakudoc b/docs/Matrix/Client/Exception.rakudoc
new file mode 100644
index 0000000..f814bbc
--- /dev/null
+++ b/docs/Matrix/Client/Exception.rakudoc
@@ -0,0 +1,52 @@
+=begin pod
+
+=TITLE Matrix::Client::Exception
+
+=SUBTITLE Module for all exceptions.
+
+=head1 X::Matrix::Response
+
+Error querying the matrix server
+
+
+ class X::Matrix::Response is Exception
+
+Error class when the matrix server returns an error code (4XX).
+
+=head2 METHODS
+
+=head3 code
+
+Returns the HTTP error code.
+
+=head3 error
+
+Returns a C<Str> with the matrix error. A full list of error codes can be
+found in the L<matrix spec|https://matrix.org/docs/spec/client_server/r0.4.0.html#api-standards>.
+
+=head3 message
+
+ method message(--> Str)
+
+Returns the exception message.
+
+=head1 X::Matrix::MXCParse
+
+Error while parsing a L<Matrix Content (MXC) URI|https://matrix.org/docs/spec/client_server/r0.6.1#matrix-content-mxc-uris>.
+
+ class X::Matrix::MXCParse is Exception
+
+
+=head2 METHODS
+
+=head3 code
+
+Returns the URI that failed to parse.
+
+=head3 message
+
+ method message(--> Str)
+
+Returns the exception message.
+
+=end pod
diff --git a/docs/requester.pod6 b/docs/Matrix/Client/Requester.rakudoc
index 6710948..2c0215d 100644
--- a/docs/requester.pod6
+++ b/docs/Matrix/Client/Requester.rakudoc
@@ -4,7 +4,6 @@
=SUBTITLE Role for HTTP requests
-
role Matrix::Client::Requester { }
Role that gives the base API for objects that interacts to the matrix server. The
@@ -28,7 +27,7 @@ Prefix to all the paths used in the methods.
=head2 get
- method get(Str $path, :$media = False, *%data)
+ method get(Str $path, :$media = False, *%data)
Do a GET to C<$path>.
diff --git a/docs/responses.pod6 b/docs/Matrix/Client/Response.rakudoc
index 7515d39..e0bed14 100644
--- a/docs/responses.pod6
+++ b/docs/Matrix/Client/Response.rakudoc
@@ -6,7 +6,6 @@
=head1 Event
-
class Matrix::Response::Event { }
Common contents of a response.
diff --git a/docs/room.pod6 b/docs/Matrix/Client/Room.rakudoc
index f186583..f186583 100644
--- a/docs/room.pod6
+++ b/docs/Matrix/Client/Room.rakudoc
diff --git a/docs/basics.pod6 b/docs/basics.rakudoc
index 5770f4f..5770f4f 100644
--- a/docs/basics.pod6
+++ b/docs/basics.rakudoc
diff --git a/docs/usage.pod6 b/docs/usage.rakudoc
index 03454d1..03454d1 100644
--- a/docs/usage.pod6
+++ b/docs/usage.rakudoc
diff --git a/docs/x-matrix-response.pod6 b/docs/x-matrix-response.pod6
deleted file mode 100644
index d93c263..0000000
--- a/docs/x-matrix-response.pod6
+++ /dev/null
@@ -1,23 +0,0 @@
-=begin pod
-
-=TITLE X::Matrix::Response
-
-=SUBTITLE Error querying the matrix server
-
-
- class X::Matrix::Response is Exception {}
-
-Error class when the matrix server returns an error code (4XX).
-
-=head1 METHODS
-
-=head2 code
-
-Returns the HTTP error code.
-
-=head2 error
-
-Returns a C<Str> with the matrix error. A full list of error codes can be
-found in the L<matrix spec|https://matrix.org/docs/spec/client_server/r0.4.0.html#api-standards>.
-
-=end pod \ No newline at end of file