Created
July 27, 2016 07:04
-
-
Save iods/40430a2edd8a6134948742ad83e5523b to your computer and use it in GitHub Desktop.
Magento 1.x DocBlock
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
<?php | |
/** | |
* Darkstar Development | |
* | |
* DISCLAIMER | |
* | |
* Do not edit or add to this file if you wish to update or upgrade the modules | |
* or applications developed by Rye Miller. If you wish to customize this for | |
* your own purpose, please contact the developer. | |
* | |
* Currently Supported for Magento CE 1.5.1+ & EE 1.13+ | |
* | |
* @category Darkstar | |
* @package Darkstar_Package | |
* @author Darkstar Magento Development <darkstardevelopers@gmail.com> | |
* @copyright Copyright (c) 2016 Rye Miller (http://bitbucket.org/thedrkstr) | |
* @link http://www.bitbucket.org/thedrkstr/ | |
* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0) | |
* | |
*/ | |
// if needed use the following doc block | |
/** | |
* Default class. | |
* | |
* Short description of class (if necessary) | |
* | |
* @category Darkstar | |
* @package Darkstar_Package | |
* @author Rye Miller <darkstardevelopers@gmail.com> | |
* @version 0.1.0 Initial development release. | |
* @since File available since release 0.1.0 | |
* | |
*/ | |
class Darkstar_Package_Folder_File extends Mage_Package_Folder_File | |
{ | |
// do some php here | |
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
<?xml version="1.0" encoding="UTF-8"?> | |
<!-- | |
/** | |
* Darkstar Development | |
* | |
* Short description of module (if necessary) | |
* | |
* @category Darkstar | |
* @package Darkstar_Package | |
* @author Darkstar Magento Development <darkstardevelopers@gmail.com> | |
* @copyright Copyright (c) 2016 Rye Miller (http://bitbucket.org/thedrkstr) | |
* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0) | |
* @link http://www.bitbucket.org/thedrkstr/ | |
* | |
*/ | |
--> | |
<layout version="0.1.0"> <!-- also config --> | |
<!-- | |
do some layout updates why don't you | |
--> | |
</layout> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
/** | |
* Darkstar Development | |
* | |
* DISCLAIMER | |
* | |
* Do not edit or add to this file if you wish to update or upgrade the modules | |
* or applications developed by Rye Miller. If you wish to customize this for | |
* your own purpose, please contact the developer. | |
* | |
* Currently Supported for Magento CE 1.5.1+ & EE 1.13+ | |
* | |
* @category Darkstar | |
* @package Darkstar_Package | |
* @author Darkstar Magento Development <darkstardevelopers@gmail.com> | |
* @copyright Copyright (c) 2016 Rye Miller (http://bitbucket.org/thedrkstr) | |
* @link http://www.bitbucket.org/thedrkstr/ | |
* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0) | |
* | |
* --------------------------------------------------------------------------------------- * | |
* TABLE OF CONTENTS * | |
* --------------------------------------------------------------------------------------- * | |
* | |
* SECTION ONE | |
* Sub-Section..........Description of the sub-section for quick reference. | |
* Sub-Section Two......Description of the sub-section for quick reference. | |
* | |
* SECTION TWO | |
* Sub-Section Three....Description of the sub-section for quick reference. | |
* Sub-Section Four.....Description of the sub-section for quick reference. | |
* | |
* TESTS................Declarations loaded independently for test-case. | |
* | |
*/ | |
/*----------------------------------------- | |
* SECTION - @Sub-Section | |
*---------------------------------------*/ | |
/** | |
* Extends 'foo' in styles.css | |
* | |
* NOTE: Due to the fixed navbar the body will need to have | |
* a margin of 60px from the top to properly display | |
* the top navbar. | |
*/ | |
.foo {} | |
/*----------------------------------------- | |
* SECTION TWO - @Sub-Section | |
*---------------------------------------*/ | |
/** | |
* TODO: We need to change the measurements of size from | |
* ems to rems for responsiveness here. | |
*/ | |
h1, | |
h2, | |
h3, | |
h4, | |
h5, | |
h6 { | |
font-family: sans-serif; | |
} | |
/**---------------------------------------- | |
* TESTS | |
* --------------------------------------*/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
/** | |
* Darkstar Development | |
* | |
* DISCLAIMER | |
* | |
* Do not edit or add to this file if you wish to update or upgrade the modules | |
* or applications developed by Rye Miller. If you wish to customize this for | |
* your own purpose, please contact the developer. | |
* | |
* Currently Supported for Magento CE 1.5.1+ & EE 1.13+ | |
* | |
* @category Darkstar | |
* @package Darkstar_Package | |
* @author Darkstar Magento Development <darkstardevelopers@gmail.com> | |
* @copyright Copyright (c) 2016 Rye Miller (http://bitbucket.org/thedrkstr) | |
* @link http://www.bitbucket.org/thedrkstr/ | |
* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0) | |
* | |
*/ | |
var = 'do some js'; |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Using the @ in section blocks of the CSS file allows for easy searching when browsing large documents.