Invokes the signUp method to sign up a user.Ģ. This code example performs the following operations:ġ. TIP: To set up the required user pool, run the AWS Cloud Development Kit (AWS CDK) script provided in this GitHub repo at resources/cdk/cognito_scenario_user_pool_with_mfa. Inline markupįor inline markup, KDoc uses the regular Markdown syntax, extended to support a shorthand syntax for linking to other elements in the code.Before running this Kotlin code example, set up your development environment, including your credentials.įor more information, see the following documentation: Can be used for elements which are not part of the official API of a module but still have to be visible externally.
the element from the generated documentation. the version of the software in which the element being documented was introduced. the author of the element being documented. identifierĪdds a link to the specified class or method to the See also block of the documentation. identifierĮmbeds the body of the function with the specified qualified name into the documentation for the current element, in order to show an example of how the element could be used. Since Kotlin does not have checked exceptions, there is also no expectation that all possible exceptions are documented, but you can still use this tag when it provides useful information for users of the class. class, classĭocuments an exception which can be thrown by a method. This tag can be used for documenting properties declared in the primary constructor, where putting a doc comment directly before the property definition would be awkward. nameĭocuments the property of a class which has the specified name. The following two syntaxes are therefore name description. To better separate the parameter name from the description, if you prefer, you can enclose the name of the parameter in brackets.
KDoc currently supports the following block tags: nameĭocuments a value parameter of a function or a type parameter of a class, property or function. * This class has no useful logic it's just a documentation example.
0 kommentar(er)
