com.google.gwt.debug.client.package-info Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of gwt-servlet Show documentation
The newest version!
/*
 * Copyright 2009 Google Inc.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

/**
 * Provides low-level functionality to support the creation of testing and
 * diagnostic frameworks.
 * 
 * 
 * To use the functionality in this package, your GWT module should inherit the
 * module com.google.gwt.debug.Debug. The Debug
 * module introduces the client property gwt.enableDebugId,
 * which controls whether or not this debug code is enabled (and therefore
 * included in the final compiled result). It is set to true by
 * default, but a module being compiled for production would very likely want to
 * set it to false to avoid unnecessary extra code in the final
 * compiled output.
 * 
 * 
Example
 * A module using this package might look like the following:
 * 
 *  * <module>
 *   <inherits name='com.google.gwt.user.User'/>
 *   
 *   <!-- Inheriting 'Debug' on the next line makes the features available. -->
 *   <inherits name='com.google.gwt.debug.Debug'/>
 *   
 *   <!-- Disable for production by uncommenting the next line -->
 *   <!-- <set-property name="gwt.enableDebugId" value="false"/> -->
 *   
 *   <entry-point class='your-entry-point-class'/>
 * </module>
 * 
 */
@com.google.gwt.util.PreventSpuriousRebuilds
package com.google.gwt.debug.client;