ART: Add comments to dex2oat return codes
Add documentation in comments. Follow-up to changes
7b5659113309e8db2558ae72870b67ebdeb7233c and
f788297b28e0c91945ae5f4d41f987514ce45e6f.
Bug: 36336122
Test: m
Change-Id: If1188fc21a337dd7689361d13fe00434c15d3202
diff --git a/dex2oat/include/dex2oat_return_codes.h b/dex2oat/include/dex2oat_return_codes.h
index cc5400f..ad09d47 100644
--- a/dex2oat/include/dex2oat_return_codes.h
+++ b/dex2oat/include/dex2oat_return_codes.h
@@ -21,9 +21,10 @@
namespace dex2oat {
enum class ReturnCode : int {
- kNoFailure = 0,
- kOther = 1,
- kCreateRuntime = 2,
+ kNoFailure = 0, // No failure, execution completed successfully.
+ kOther = 1, // Some other not closer specified error occurred.
+ kCreateRuntime = 2, // Dex2oat failed creating a runtime. This may be indicative
+ // of a missing or out of date boot image, for example.
};
} // namespace dex2oat
