Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit e9f17cda authored by Jean-Luc Brouillet's avatar Jean-Luc Brouillet Committed by Joe Fernandez
Browse files

docs: Overhaul of the RenderScript reference documentation. 

cherry-pick from CL: https://android-review.googlesource.com/148241

This CL replaces the Doxygen generated documentation by one that's created
by our internal tool found in framework/rs/api.  The big advantages:

- Can handle overloaded functions.  Doxygen could not and RenderScript has many.
- Can have version information.
- Can match the look of the Java documentation.
- Cleaner look and no leaking of internal paths.

This CL also include changes introduced by the L release which was missing
previously.

Change-Id: Icade41d04d35e45c445ad952bb8ce14389f9f59f
parent 023901c6

docs/html/guide/guide_toc.cs

+55 −3
Original line number Diff line number Diff line
@@ -357,8 +357,61 @@ 
              <li><a href="<?cs var:toroot ?>guide/topics/renderscript/advanced.html">

                    <span class="en">Advanced RenderScript</span></a>

                  </li>

              <li><a href="<?cs var:toroot ?>guide/topics/renderscript/reference.html">

                    <span class="en">Runtime API Reference</span></a>

              <li class="nav-section">

                <div class="nav-section-header">

                  <a href="<?cs var:toroot ?>guide/topics/renderscript/reference/overview.html">

                    <span class="en">Runtime API Reference</span>

                  </a></div>

                <ul>

                  <li><a href="<?cs var:toroot ?>guide/topics/renderscript/reference/rs_value_types.html">

                    <span class="en">Numerical Types</span>

                  </a></li>

                  <li><a href="<?cs var:toroot ?>guide/topics/renderscript/reference/rs_object_types.html">

                    <span class="en">Object Types</span>

                  </a></li>

                  <li><a href="<?cs var:toroot ?>guide/topics/renderscript/reference/rs_convert.html">

                    <span class="en">Conversion Functions</span>

                  </a></li>

                  <li><a href="<?cs var:toroot ?>guide/topics/renderscript/reference/rs_math.html">

                    <span class="en">Mathematical Constants and Functions</span>

                  </a></li>

                  <li><a href="<?cs var:toroot ?>guide/topics/renderscript/reference/rs_vector_math.html">

                    <span class="en">Vector Math Functions</span>

                  </a></li>

                  <li><a href="<?cs var:toroot ?>guide/topics/renderscript/reference/rs_matrix.html">

                    <span class="en">Matrix Functions</span>

                  </a></li>

                  <li><a href="<?cs var:toroot ?>guide/topics/renderscript/reference/rs_quaternion.html">

                    <span class="en">Quaternion Functions</span>

                  </a></li>

                  <li><a href="<?cs var:toroot ?>guide/topics/renderscript/reference/rs_atomic.html">

                    <span class="en">Atomic Update Functions</span>

                  </a></li>

                  <li><a href="<?cs var:toroot ?>guide/topics/renderscript/reference/rs_time.html">

                    <span class="en">Time Functions and Types</span>

                  </a></li>

                  <li><a href="<?cs var:toroot ?>guide/topics/renderscript/reference/rs_allocation_data.html">

                    <span class="en">Allocation Data Access Functions</span>

                  </a></li>

                  <li><a href="<?cs var:toroot ?>guide/topics/renderscript/reference/rs_object_info.html">

                    <span class="en">Object Characteristics Functions</span>

                  </a></li>

                  <li><a href="<?cs var:toroot ?>guide/topics/renderscript/reference/rs_for_each.html">

                    <span class="en">Kernel Invocation Functions and Types</span>

                  </a></li>

                  <li><a href="<?cs var:toroot ?>guide/topics/renderscript/reference/rs_io.html">

                    <span class="en">Input/Output Functions</span>

                  </a></li>

                  <li><a href="<?cs var:toroot ?>guide/topics/renderscript/reference/rs_debug.html">

                    <span class="en">Debugging Functions</span>

                  </a></li>

                  <li><a href="<?cs var:toroot ?>guide/topics/renderscript/reference/rs_graphics.html">

                    <span class="en">Graphics Functions and Types</span>

                  </a></li>

                  <li><a href="<?cs var:toroot ?>guide/topics/renderscript/reference/index.html">

                    <span class="en">Index</span>

                  </a></li>

                </ul>

              </li>

             </ul>

   </li>
@@ -588,4 +641,3 @@ 
    changeNavLang(getLangPref());

//-->

</script>

docs/html/guide/topics/renderscript/reference/index.jd

0 → 100644
+2837 −0

File added.

Preview size limit exceeded, changes collapsed.

docs/html/guide/topics/renderscript/reference/overview.jd

0 → 100644
+2676 −0

File added.

Preview size limit exceeded, changes collapsed.

docs/html/guide/topics/renderscript/reference/rs_allocation_data.jd

0 → 100644
+2925 −0

File added.

Preview size limit exceeded, changes collapsed.

docs/html/guide/topics/renderscript/reference/rs_atomic.jd

0 → 100644
+506 −0

File added.

Preview size limit exceeded, changes collapsed.