Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(22)

Unified Diff: src/IceBrowserCompileServer.h

Issue 1216963007: Doxygenize the documentation comments (Closed) Base URL: https://chromium.googlesource.com/native_client/pnacl-subzero.git@master
Patch Set: Rebase to master Created 5 years, 5 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « src/IceAssemblerX8664.cpp ('k') | src/IceBrowserCompileServer.cpp » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: src/IceBrowserCompileServer.h
diff --git a/src/IceBrowserCompileServer.h b/src/IceBrowserCompileServer.h
index f15ddafb93ad964c97fcc4403a3100d11a780e77..e76b820679f00fb64a6c48fa0c6f869c9069efbc 100644
--- a/src/IceBrowserCompileServer.h
+++ b/src/IceBrowserCompileServer.h
@@ -6,9 +6,10 @@
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
-//
-// This file declares the browser-specific compile server.
-//
+///
+/// \file
+/// This file declares the browser-specific compile server.
+///
//===----------------------------------------------------------------------===//
#ifndef SUBZERO_SRC_ICEBROWSERCOMPILESERVER_H
@@ -30,12 +31,12 @@ class raw_fd_ostream;
namespace Ice {
-// The browser variant of the compile server.
-// Compared to the commandline version, this version gets compile
-// requests over IPC. Each compile request will have a slimmed down
-// version of argc, argv while other flags are set to defaults that
-// make sense in the browser case. The output file is specified via
-// a posix FD, and input bytes are pushed to the server.
+/// The browser variant of the compile server.
+/// Compared to the commandline version, this version gets compile
+/// requests over IPC. Each compile request will have a slimmed down
+/// version of argc, argv while other flags are set to defaults that
+/// make sense in the browser case. The output file is specified via
+/// a posix FD, and input bytes are pushed to the server.
class BrowserCompileServer : public CompileServer {
BrowserCompileServer() = delete;
BrowserCompileServer(const BrowserCompileServer &) = delete;
@@ -52,21 +53,21 @@ public:
ErrorCode &getErrorCode() final;
- // Parse and set up the flags for compile jobs.
+ /// Parse and set up the flags for compile jobs.
void getParsedFlags(uint32_t NumThreads, int argc, char **argv);
- // Creates the streams + context and starts the compile thread,
- // handing off the streams + context.
+ /// Creates the streams + context and starts the compile thread,
+ /// handing off the streams + context.
void startCompileThread(int OutFD);
- // Call to push more bytes to the current input stream.
- // Returns false on success and true on error.
+ /// Call to push more bytes to the current input stream.
+ /// Returns false on success and true on error.
bool pushInputBytes(const void *Data, size_t NumBytes);
- // Notify the input stream of EOF.
+ /// Notify the input stream of EOF.
void endInputStream();
- // Wait for the compile thread to complete then reset the state.
+ /// Wait for the compile thread to complete then reset the state.
void waitForCompileThread() {
CompileThread.join();
if (Ctx->getErrorStatus()->value())
@@ -94,12 +95,12 @@ private:
std::string Buffer;
llvm::raw_string_ostream StrBuf;
};
- // This currently only handles a single compile request, hence one copy
- // of the state.
+ /// This currently only handles a single compile request, hence one copy
+ /// of the state.
std::unique_ptr<GlobalContext> Ctx;
- // A borrowed reference to the current InputStream. The compiler owns
- // the actual reference so the server must be careful not to access
- // after the compiler is done.
+ /// A borrowed reference to the current InputStream. The compiler owns
+ /// the actual reference so the server must be careful not to access
+ /// after the compiler is done.
llvm::QueueStreamer *InputStream = nullptr;
std::unique_ptr<Ostream> LogStream;
std::unique_ptr<llvm::raw_fd_ostream> EmitStream;
« no previous file with comments | « src/IceAssemblerX8664.cpp ('k') | src/IceBrowserCompileServer.cpp » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698