Fix badly formed XML doc comments (#143)

This commit is contained in:
Kevin Asgari 2017-05-04 14:51:16 -07:00 коммит произвёл Jason Sandlin
Родитель 807b9fbebc
Коммит 76496a2af6
7 изменённых файлов: 17 добавлений и 17 удалений

Просмотреть файл

@ -4181,7 +4181,7 @@ public:
/// Queries for the all search handles that references the searchable sessions given the specific query.
/// There is no paging or continuation, and the multiplayer service will limit the number of items returned to 100.
/// </summary>
/// <param name="searchHandleRequest" A search handle request object that queries for the all search handles.</param>
/// <param name="searchHandleRequest"> A search handle request object that queries for the all search handles.</param>
/// <returns>The async object for notifying when the operation is completed. This contains a vectorview of multiplayer_search_handle_details objects, containing the details of the search handles.</returns>
_XSAPIIMP pplx::task<xbox_live_result<std::vector<multiplayer_search_handle_details>>> get_search_handles(
_In_ const multiplayer_query_search_handle_request& searchHandleRequest

Просмотреть файл

@ -80,21 +80,21 @@ public:
/// Return data as numerical type
/// </summary>
/// <returns>Float data for statistic</returns>
/// <remarks>Will debug assert if data is not type requested</returns>
/// <remarks>Will debug assert if data is not type requested</remarks>
_XSAPIIMP double as_number() const;
/// <summary>
/// Return data as integer type
/// </summary>
/// <returns>Float data for statistic</returns>
/// <remarks>Will debug assert if data is not type requested</returns>
/// <remarks>Will debug assert if data is not type requested</remarks>
_XSAPIIMP int64_t as_integer() const;
/// <summary>
/// Return data as string type
/// </summary>
/// <returns>data as char_t*</returns>
/// <remarks>Will debug assert if data is not type requested</returns>
/// <remarks>Will debug assert if data is not type requested</remarks>
_XSAPIIMP const string_t as_string() const;
/// <summary>

Просмотреть файл

@ -525,7 +525,7 @@ public:
/// </summary>
/// <returns>An team_request_result object that contains a list of team_info objects.</returns>
/// <remarks>
/// Returns a concurrency::task<T> object that represents the state of the asynchronous operation.
/// Returns a concurrency::task{T} object that represents the state of the asynchronous operation.
/// </remarks>
_XSAPIIMP pplx::task<xbox::services::xbox_live_result<team_request_result>> get_next();
@ -851,7 +851,7 @@ public:
/// </summary>
/// <returns>An tournament_request_result object that contains a list of tournament objects.</returns>
/// <remarks>
/// Returns a concurrency::task<T> object that represents the state of the asynchronous operation.
/// Returns a concurrency::task{T} object that represents the state of the asynchronous operation.
/// </remarks>
_XSAPIIMP pplx::task<xbox::services::xbox_live_result<tournament_request_result>> get_next();
@ -1051,7 +1051,7 @@ public:
/// <param name="request">A tournament request object that retrieves tournaments based on the configuration of the request.</param>
/// <returns>A list of tournaments if it exist.</returns>
/// <remarks>
/// Returns a concurrency::task<T> object that represents the state of the asynchronous operation.
/// Returns a concurrency::task{T} object that represents the state of the asynchronous operation.
/// This method calls GET /tournaments
/// </remarks>
_XSAPIIMP pplx::task<xbox::services::xbox_live_result<tournament_request_result>> get_tournaments(
@ -1066,7 +1066,7 @@ public:
/// <param name="tournamentId">The ID of the tournament.</param>
/// <returns>The specific tournament if they exist.</returns>
/// <remarks>
/// Returns a concurrency::task<T> object that represents the state of the asynchronous operation.
/// Returns a concurrency::task{T} object that represents the state of the asynchronous operation.
/// This method calls GET /tournaments/{organizer}/{id}.
/// </remarks>
_XSAPIIMP pplx::task<xbox::services::xbox_live_result<tournament>> get_tournament_details(
@ -1080,7 +1080,7 @@ public:
/// <param name="request">A team request object that retrieves team based on the configuration of the request.</param>
/// <returns>A list of teams if they exist.</returns>
/// <remarks>
/// Returns a concurrency::task<T> object that represents the state of the asynchronous operation.
/// Returns a concurrency::task{T} object that represents the state of the asynchronous operation.
/// This method calls GET /tournaments/{organizer}/{id}/teams
/// </remarks>
_XSAPIIMP pplx::task<xbox::services::xbox_live_result<team_request_result>> get_teams(
@ -1096,7 +1096,7 @@ public:
/// <param name="teamId">The ID of the team.</param>
/// <returns>A specific tournament if they exist.</returns>
/// <remarks>
/// Returns a concurrency::task<T> object that represents the state of the asynchronous operation.
/// Returns a concurrency::task{T} object that represents the state of the asynchronous operation.
/// This method calls GET /tournaments/{organizer}/{id}/teams/{teamId}
/// </remarks>
_XSAPIIMP pplx::task<xbox::services::xbox_live_result<team_info>> get_team_details(

Просмотреть файл

@ -538,7 +538,7 @@ public:
/// Queries for the all search handles that references the searchable sessions given the specific query.
/// There is no paging or continuation, and the multiplayer service will limit the number of items returned to 100.
/// </summary>
/// <param name="searchHandleRequest" A search handle request object that queries for the all search handles.</param>
/// <param name="searchHandleRequest"> A search handle request object that queries for the all search handles.</param>
/// <returns>The async object for notifying when the operation is completed. This contains a vectorview of MultiplayerSearchHandleDetails objects, containing the details of the search handles.</returns>
Windows::Foundation::IAsyncOperation<Windows::Foundation::Collections::IVectorView<MultiplayerSearchHandleDetails^>^>^ GetSearchHandlesAsync(
_In_ MultiplayerQuerySearchHandleRequest^ searchHandleRequest

Просмотреть файл

@ -33,7 +33,7 @@ public:
/// </summary>
/// <returns>An TeamRequestResult object that contains a list of tournament objects.</returns>
/// <remarks>
/// Returns a concurrency::task<T> object that represents the state of the asynchronous operation.
/// Returns a concurrency::task{T} object that represents the state of the asynchronous operation.
/// </remarks>
Windows::Foundation::IAsyncOperation<TeamRequestResult^>^ GetNextAsync();

Просмотреть файл

@ -33,7 +33,7 @@ public:
/// </summary>
/// <returns>An TournamentRequestResult object that contains a list of tournament objects.</returns>
/// <remarks>
/// Returns a concurrency::task<T> object that represents the state of the asynchronous operation.
/// Returns a concurrency::task{T} object that represents the state of the asynchronous operation.
/// </remarks>
Windows::Foundation::IAsyncOperation<TournamentRequestResult^>^ GetNextAsync();

Просмотреть файл

@ -49,7 +49,7 @@ public:
/// <param name="request">A tournament request object that retrieves tournaments based on the configuration of the request.</param>
/// <returns>A list of tournaments if they exist.</returns>
/// <remarks>
/// Returns a concurrency::task<T> object that represents the state of the asynchronous operation.
/// Returns a concurrency::task{T} object that represents the state of the asynchronous operation.
/// This method calls GET /tournaments
/// </remarks>
Windows::Foundation::IAsyncOperation<TournamentRequestResult^>^ GetTournamentsAsync(
@ -64,7 +64,7 @@ public:
/// <param name="tournamentId">The ID of the tournament.</param>
/// <returns>The specific tournament if they exist.</returns>
/// <remarks>
/// Returns a concurrency::task<T> object that represents the state of the asynchronous operation.
/// Returns a concurrency::task{T} object that represents the state of the asynchronous operation.
/// This method calls GET /tournaments/{organizer}/{id}.
/// </remarks>
Windows::Foundation::IAsyncOperation<Tournament^>^ GetTournamentDetailsAsync(
@ -78,7 +78,7 @@ public:
/// <param name="request">A team request object that retrieves team based on the configuration of the request.</param>
/// <returns>A list of teams if they exist.</returns>
/// <remarks>
/// Returns a concurrency::task<T> object that represents the state of the asynchronous operation.
/// Returns a concurrency::task{T} object that represents the state of the asynchronous operation.
/// This method calls GET /tournaments/{organizer}/{id}/teams
/// </remarks>
Windows::Foundation::IAsyncOperation<TeamRequestResult^>^ GetTeamsAsync(
@ -94,7 +94,7 @@ public:
/// <param name="teamId">The ID of the team.</param>
/// <returns>A specific tournament if they exist.</returns>
/// <remarks>
/// Returns a concurrency::task<T> object that represents the state of the asynchronous operation.
/// Returns a concurrency::task{T} object that represents the state of the asynchronous operation.
/// This method calls GET /tournaments/{organizer}/{id}/teams/{teamId}
/// </remarks>
Windows::Foundation::IAsyncOperation<TeamInfo^>^ GetTeamDetailsAsync(