Skip to content

Instantly share code, notes, and snippets.

@djcsdy
Created September 1, 2012 20:28
Show Gist options
  • Save djcsdy/3586294 to your computer and use it in GitHub Desktop.
Save djcsdy/3586294 to your computer and use it in GitHub Desktop.
Cut-down haxedoc.xml illustrating a bug in haxedoc.
<haxe>
<typedef path="kong.Services" params="" file="./kong/Services.hx"><a>
<showRegistrationBox set="method">
<f a=""><e path="Void"/></f>
<haxe_doc>Displays the user registration UI.
*
* This is useful if the player is a guest but you want to authenticate them for a multiplayer game,
* or to upsell an item.</haxe_doc>
</showRegistrationBox>
<isGuest set="method">
<f a=""><e path="Bool"/></f>
<haxe_doc>Tests of the player is a guest. A guest is an anonymous player who is not logged in to Kongregate.</haxe_doc>
</isGuest>
<getUsername set="method">
<f a=""><c path="String"/></f>
<haxe_doc>Retrieves the user name of the current player. If the player is not logged in, then they will be assigned
* a temporary user name that begins with the string "Guest".</haxe_doc>
</getUsername>
<getUserId set="method">
<f a=""><c path="String"/></f>
<haxe_doc>Retrieves the unique user ID of the current player. Returns "0" if the player is not logged in.</haxe_doc>
</getUserId>
<getGameAuthToken set="method">
<f a=""><c path="String"/></f>
<haxe_doc>Gets the player's game authentication token, which is required when calling the authentication web service.</haxe_doc>
</getGameAuthToken>
<connect set="method"><f a=""><e path="Void"/></f></connect>
<addEventListener set="method">
<f a="type:listener">
<c path="String"/>
<f a="">
<c path="flash.events.Event"/>
<e path="Void"/>
</f>
<e path="Void"/>
</f>
<haxe_doc>Adds an event listener that will be called when Kongregate dispatches an event of the specified type.
*
* [type] should be one of the constants defined by [EventType].</haxe_doc>
</addEventListener>
</a></typedef>
</haxe>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment