From cded5ecfc3e51052cd8353c8867f2bdcd0535756 Mon Sep 17 00:00:00 2001
From: Paul Duffin <paulduffin@google.com>
Date: Fri, 10 Jan 2020 17:30:36 +0000
Subject: Document java_system_modules

Bug: 142940300
Test: m nothing
Change-Id: Ic658226088615dbeeef15f17dbb095a968e0742d
---
 java/system_modules.go | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'java/system_modules.go')

diff --git a/java/system_modules.go b/java/system_modules.go
index ed2fc1856..81e5cb462 100644
--- a/java/system_modules.go
+++ b/java/system_modules.go
@@ -92,6 +92,9 @@ func TransformJarsToSystemModules(ctx android.ModuleContext, jars android.Paths)
 	return outDir, outputs.Paths()
 }
 
+// java_system_modules creates a system module from a set of java libraries that can
+// be referenced from the system_modules property. It must contain at a minimum the
+// java.base module which must include classes from java.lang amongst other java packages.
 func SystemModulesFactory() android.Module {
 	module := &SystemModules{}
 	module.AddProperties(&module.properties)
-- 
cgit v1.2.3-59-g8ed1b