markeissler

YARD CHEATSHEET http://yardoc.org

cribbed from http://pastebin.com/xgzeAmBn

Templates to remind you of the options and formatting for the different types of objects you might want to document using YARD.

Modules

Namespace for classes and modules that handle serving documentation over HTTP

markeissler

# if running bash
if [ -n "$BASH_VERSION" ]; then
    # include .bashrc if it exists
    if [ -f "$HOME/.bashrc" ]; then
        . "$HOME/.bashrc"
    fi
fi

markeissler

Synopsis

At the top of the file there should be a short introduction and/ or overview that explains what the project is. This description should match descriptions added for package managers (Gemspec, package.json, etc.)

Code Example

Show what the library does as concisely as possible, developers should be able to figure out how your project solves their problem by looking at the code example. Make sure the API you are showing off is obvious, and that your code is short and concise.

Motivation

markeissler

/*
	Some sample code for a horizontal paged UIScrollView with a gap between each image (which looks nicer). Note - not using contentInset, we want each page to fill the iPhone screen and the gap only to be visible when scrolling (like Photos.app).
	
	Taking the iPhone status bar into account - our viewport is 320x460
	Our UIScrollView is therefore set in Interface Builder to 340x460 with a -10 X offset (so it's larger than the viewport but still centred)
	
	Then we do the following...
*/

// Our image filenames

markeissler

ps -A | grep diskimages-helper | awk '{print $1}' | xargs kill -9

markeissler

[user]
	name = VonC
	email = [email protected]
[core]
; just making sure those eol's stay as they are
	autocrlf = false
; see http://stackoverflow.com/a/22208863/6309 (Git/Bash is extremely slow in Windows 7 x64, until fix in msysgit 1.9.4)	
	fscache = true
[alias]
; from http://www.jukie.net/bart/blog/pimping-out-git-log, with author displayed

markeissler

1. Create a UIView subclass for the pin callout view.
2. Create a subclass of MKAnnotationView for your map pins.
3. Add an instance of the callout view subclass to your MKAnnotationView subclass.
4. Add a property to toggle the callout view to your MKAnnotationView subclass. This example fades in/out:

   - (void)setShowCustomCallout:(BOOL)showCustomCallout
   {
       [self setShowCustomCallout:showCustomCallout animated:NO];
   }
   

markeissler

a[href^="http://"]:after {
  content: "\f08e";
  font-family: FontAwesome;
  font-weight: normal;
  font-style: normal;
  display: inline-block;
  text-decoration: none;
  padding-left: 3px;
}
/* Strip from links to own domain or with class no_icon */

markeissler

Generate private key (.key)

# Key considerations for algorithm "RSA" ≥ 2048-bit
openssl genrsa -out server.key 2048
    
# Key considerations for algorithm "ECDSA" ≥ secp384r1
# List ECDSA the supported curves (openssl ecparam -list_curves)
openssl ecparam -genkey -name secp384r1 -out server.key

markeissler

#
# Vagrantfile for testing
#
Vagrant::configure("2") do |config|

  # the Chef version to use
  config.omnibus.chef_version = "11.4.4"

  def configure_vbox_provider(config, name, ip, memory = 384)
    config.vm.provider :virtualbox do |vbox, override|